A plain-language inventory of the data submitted to the Health Resources and Services Administration (HRSA) HIV/AIDS Bureau (HAB) through the Ryan White HIV/AIDS Program Services Report (RSR).
This is the readable companion to the full CSV and HTML editions. The dictionary includes required XML structure, web-form fields, provider aggregates, client-level XML values, and clearly labeled system-calculated counts. A field marked Conditional is required only when the rule in the When required column applies.
- Field / XML path shows the web-form label or the technical XML location.
- Type and values separates documented formats from inferred web-form types. When the documents do not define a formal type, the table says so.
- Derived? / how explains system-assigned, counted, transformed, or calculated values. A blank means the field is entered or reported directly.
- Occurrence in the full CSV and HTML editions tells how many times a value or structure may appear.
- Source uses the printed page number visible in each PDF unless it explicitly says PDF page.
The full code-set file lists each code on its own row, and the validation-rule file lists the reviewed system checks. See README for source precedence, known conflicts, and limitations.
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-FILE-001 | XML declaration | Declares the XML version and UTF-8 character encoding. | Fixed XML text |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide pp. 2, 21 (§§2.1, 4.1) |
| RSR-FILE-002 | RSR:ROOT root element and namespace attributes/RSR:ROOT |
Opens the RSR file and identifies its XML schema and namespaces. | Complex XML element RSR:ROOT with xsi:schemaLocation="urn:rsrNamespace RsrClientSchema.xsd"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xmlns:RSR="urn:rsrNamespace" |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide pp. 2, 21 (§§2.2, 4.1) |
| RSR-FILE-003 | XmlVersion container/RSR:ROOT/XmlVersion |
Groups the schema, software, contact, and report-year file information. | Complex XML element Contains RSR-FILE-004 through RSR-FILE-010 in XSD order |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide pp. 3–5, 21–22 (§§3.1, 4.2) |
| RSR-FILE-004 | SchemaVersion/RSR:ROOT/XmlVersion/SchemaVersion |
Identifies the RSR XML schema version currently supported. | Version string 5.2.0 |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.4, section 3.1.1 |
| RSR-FILE-005 | Originator/RSR:ROOT/XmlVersion/Originator |
Names the application that generated the XML file. | Text 1–150 characters; special characters are excluded but the excluded set is not listed. |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.4, section 3.1.2 |
| RSR-FILE-006 | VersionNumber/RSR:ROOT/XmlVersion/VersionNumber |
Version of the application that generated the XML file. | Text 1–150 characters; special characters are excluded but the excluded set is not listed. |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.4, section 3.1.3 |
| RSR-FILE-007 | TechnicalContactName/RSR:ROOT/XmlVersion/TechnicalContactName |
Technical contact for the application that generated the file. | Text 1–150 characters; special characters are excluded but the excluded set is not listed. |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.5, section 3.1.4 |
| RSR-FILE-008 | TechnicalContactEmail/RSR:ROOT/XmlVersion/TechnicalContactEmail |
Email for the technical contact. | Email Valid email address |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.5, section 3.1.5 |
| RSR-FILE-009 | TechnicalContactPhone/RSR:ROOT/XmlVersion/TechnicalContactPhone |
Phone number for the technical contact. | Phone 999,999,9999 x99999; extension is optional and requires one space before x. |
Required | Every client-level XML file. | No | RSR XML Implementation Guide v3.10, Guide p.5, section 3.1.6 |
| RSR-FILE-010 | ReportYear/RSR:ROOT/XmlVersion/ReportYear |
Identifies the reporting period. | Four-digit year YYYY; must equal the submission reporting period year (2025 for this dictionary). |
Required | Every client-level XML file. | Derived: Use the reporting year assigned to the RSR submission. | RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Guide p.5, section 3.1.7; Validation pp.8-13 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-REC-001 | Official mailing address — street | Street line of the recipient official mailing address. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile in HRSA EHBs. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-002 | Official mailing address — city | City of the recipient official mailing address. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile in HRSA EHBs. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-003 | Official mailing address — state | State of the recipient official mailing address. | State code / selection (formal options not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile in HRSA EHBs. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-004 | Official mailing address — ZIP code | ZIP code of the recipient official mailing address. | ZIP code stored as text Required address component; keep leading zeros in ZIP codes. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile in HRSA EHBs. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-005 | EIN | The recipient Employer Identification Number. | Identifier (formal pattern not specified here) Valid EIN; exact pattern is not stated in the reviewed documents. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-006 | UEI | The recipient Unique Entity Identifier. | 12-character alphanumeric identifier Valid 12-character UEI assigned through SAM.gov. |
Required | Every Recipient Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-007 | Submission contact — name | Contact information for the person responsible for this Recipient Report submission. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-008 | Submission contact — title | Contact information for the person responsible for this Recipient Report submission. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-009 | Submission contact — phone | Contact information for the person responsible for this Recipient Report submission. | Phone (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Recipient Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-010 | Submission contact — extension | Contact information for the person responsible for this Recipient Report submission. | Text / digits (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-011 | Submission contact — fax | Contact information for the person responsible for this Recipient Report submission. | Phone (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-012 | Submission contact — email | Contact information for the person responsible for this Recipient Report submission. | Email A valid email address. |
Required | Every Recipient Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-013 | Received Minority AIDS Initiative designation | Whether a Part C or Part D recipient received an MAI designation during the reporting period. | Single select Code set YES_NO (2 values); see the code-set CSV. |
Conditional | RWHAP Parts C and D Recipient Reports. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-014 | Most recent MAI percentage designation | The most recent MAI percentage designation for the reporting period. | Percentage (precision/range not formally specified) Numeric percent from the Notice of Award. |
Conditional | When the MAI designation response is Yes. | Prepopulated / source document: Use the most recent official percentage designation for the reporting period; do not calculate from client data. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 19; Validation p. 2 |
| RSR-REC-015 | Funded provider organization | An organization funded to provide services during the reporting period. | Repeated provider relationship Provider organizations whose GCMS contract dates overlap the reporting period. |
Prepopulated / confirm | At least one provider must be listed for each Recipient Report. | Prepopulated: Select contracts whose dates overlap the RSR period. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 21–22; Validation p. 2 |
| RSR-REC-016 | Funded service categories by provider | The service categories each provider was funded to deliver with the award. | Multi-select relationship Code set PROVIDER_SERVICE_CATEGORY (33 values); see the code-set CSV. |
Prepopulated / confirm | Every listed provider must have at least one funded service. | Prepopulated: Combined from applicable contracts, including RWHAP-related funded services. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 21–22, 28; Validation p. 2 |
| RSR-REC-017 | Provider exempt from separate reporting | Whether the provider meets an allowed exemption and will be reported through another Provider Report. | Checkbox / Yes-No Code set YES_NO (2 values); see the code-set CSV. |
Required | For each listed provider. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 23–25; Validation p. 2 |
| RSR-REC-018 | Provider exemption explanation | A short explanation showing why the provider meets an exemption criterion. | Text (formal length not specified) Brief reason based on one or more manual exemption criteria. |
Conditional | When the provider exemption box is selected. | No | 2025 RSR Instruction Manual, Manual p. 24 |
| RSR-REC-019 | Certification comment | Meaningful feedback about the submission process. | Text (formal length not specified) Free text; do not include protected health information. |
Optional | When the submitter has useful feedback. | No | 2025 RSR Instruction Manual, Manual p. 26 |
| RSR-REC-020 | Accuracy and completeness certification | The recipient attests that the report is accurate and complete. | Required checkbox / attestation Checked / certified. |
Required | Before certifying the Recipient Report. | No | 2025 RSR Instruction Manual, Manual p. 26 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-CLD-001 | ProviderID/RSR:ROOT/ClientReport/ProviderID |
Links the client record to the provider organization. | Integer Existing HAB-assigned provider ID |
Conditional | Required only for a batch submission; normally not required for a file uploaded inside one Provider Report. | System-assigned: Assigned in the RSR web system; when submitted it is cross-checked against the Provider Report. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10, Manual pp. 75–76; Guide p. 6 |
| RSR-CLD-002 | RegistrationCode/RSR:ROOT/ClientReport/RegistrationCode |
Links a client record to the provider registration. | Numeric string Existing HAB-assigned registration code |
Optional | May be included and cross-checked; not required for a normal web upload. | System-assigned: Assigned in the RSR web system; when submitted it is cross-checked against the Provider Report. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10, Manual pp. 75–76; Guide p. 6 |
| RSR-PROV-001 | EIN | The provider Employer Identification Number. | Identifier (formal pattern not specified) Valid EIN. |
Optional | Expected for the Provider Report; missing data creates a warning rather than an error. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-002 | UEI | The provider Unique Entity Identifier. | 12-character alphanumeric identifier Valid 12-character UEI assigned through SAM.gov. |
Optional | Expected for the Provider Report; missing data creates a warning rather than an error. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-003 | NPI | The 10-digit National Provider Identifier for the HIV services provider. | 10-digit identifier stored as text Exactly 10 digits; preserve leading zeros if any. |
Optional | Report when the provider has an NPI. | No | 2025 RSR Instruction Manual, Manual pp. 40, 69 |
| RSR-PROV-004 | Official mailing address — street | Street line of the provider official mailing address. | Text (formal length not specified) Required address component. |
Required | Every Provider Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-005 | Official mailing address — city | City of the provider official mailing address. | Text (formal length not specified) Required address component. |
Required | Every Provider Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-006 | Official mailing address — state | State of the provider official mailing address. | State code / selection Required address component. |
Required | Every Provider Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-007 | Official mailing address — ZIP code | ZIP code of the provider official mailing address. | ZIP code stored as text Required address component. |
Required | Every Provider Report. | Prepopulated: Pulled from the organization profile. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-008 | Organization contact — name | A contact detail for a provider organization contact. | Text (formal length not specified) Repeat for each contact; at least one organization contact is required. |
Conditional | At least one contact record must be present. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-009 | Organization contact — title | A contact detail for a provider organization contact. | Text (formal length not specified) Repeat for each contact; at least one organization contact is required. |
Conditional | At least one contact record must be present. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-010 | Organization contact — phone number | A contact detail for a provider organization contact. | Phone (formal pattern not specified) Repeat for each contact; at least one organization contact is required. |
Conditional | At least one contact record must be present. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-011 | Organization contact — email | A contact detail for a provider organization contact. | Email Repeat for each contact; at least one organization contact is required. |
Conditional | At least one contact record must be present. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-012 | Organization contact — fax | A contact detail for a provider organization contact. | Phone (formal pattern not specified) Repeat for each contact; at least one organization contact is required. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-013 | Organization contact — primary point of contact | A contact detail for a provider organization contact. | Checkbox / Yes-No Code set YES_NO (2 values); see the code-set CSV. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 40; Validation p. 3 |
| RSR-PROV-014 | Provider type | The single category that best describes the provider agency. | Single select Code set PROVIDER_TYPE (11 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 40–41; Validation p. 3 |
| RSR-PROV-015 | Other provider type description | A description of a provider that does not fit a listed provider type. | Text (formal length not specified) Free text description. |
Conditional | When Provider type is Other provider type. | No | 2025 RSR Instruction Manual, Manual p. 41 |
| RSR-PROV-016 | Section 330 funding received | Whether the provider received Section 330 funding during the reporting period. | Single select Code set YES_NO_UNKNOWN (3 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 41; Validation p. 3 |
| RSR-PROV-017 | Ownership type | The category that describes who owns and operates the provider. | Single select Code set OWNERSHIP_TYPE (7 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 42; Validation p. 3 |
| RSR-PROV-018 | Faith-based organization | Whether the provider considers itself faith-based. | Single select Code set YES_NO (2 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 42; Validation p. 3 |
| RSR-PROV-019 | Part of a real-time electronic data network | Whether the provider is part of a network that lets authorized providers share and manage client health information. | Single select Code set YES_NO_UNKNOWN (3 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 42; Validation p. 3 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-PROG-001 | Submission contact — name | Contact information for the person responsible for the Provider Report submission. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-002 | Submission contact — title | Contact information for the person responsible for the Provider Report submission. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-003 | Submission contact — phone | Contact information for the person responsible for the Provider Report submission. | Phone (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-004 | Submission contact — extension | Contact information for the person responsible for the Provider Report submission. | Text / digits (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-005 | Submission contact — fax | Contact information for the person responsible for the Provider Report submission. | Phone (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-006 | Submission contact — email | Contact information for the person responsible for the Provider Report submission. | Email A valid email address. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 47; Validation p. 4 |
| RSR-PROG-007 | Clinical quality management program status | The current status of the provider clinical quality management program. | Single select Code set CQM_STATUS (4 values); see the code-set CSV. |
Required | Every Provider Report. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 48; Validation p. 4 |
| RSR-PROG-008 | Funding source certification | The provider confirms that the displayed RWHAP, RWHAP-related, and EHE funding sources and services are correct. | Required checkbox / attestation Acknowledged / certified. |
Prepopulated / confirm | Every Provider Report. | Prepopulated: Combined from GCMS/Recipient Report funding relationships. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual p. 49; Validation p. 4 |
| RSR-PROG-011 | Delivered funded service category | A funded service category the provider actually delivered during the reporting period. | Multi-select / checkbox by service Code set PROVIDER_SERVICE_CATEGORY (33 values); see the code-set CSV. |
Conditional | For each service delivered using RWHAP, RWHAP-related, or EHE funding. | Derived: Compare program/service records with the funded service list and mark each category actually delivered. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 50–53; Validation p. 5 |
| RSR-PROG-012 | Additional service category delivered | A service delivered by a provider-only agency using its own RWHAP-related funding, including program income or pharmaceutical rebates. | Multi-select / checkbox by service Code set PROVIDER_SERVICE_CATEGORY (33 values); see the code-set CSV. |
Conditional | Provider-only agencies that generated and used their own RWHAP-related funding for the service. | Derived: Include only services delivered with the provider’s own RWHAP-related funding. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 50–53; Validation p. 5 |
| RSR-PROG-013 | Warning validation comment | A short explanation for an unresolved warning. | Text (formal length not specified) Free text related to the warning; never include protected health information. |
Conditional | For each warning that remains when submitting the Provider Report. | No | 2025 RSR Instruction Manual, Manual pp. 62–63 |
| RSR-PROG-014 | Submission comment | Meaningful feedback about the submission process. | Text (formal length not specified) Free text; do not include protected health information. |
Optional | When the submitter has useful feedback. | No | 2025 RSR Instruction Manual, Manual p. 64 |
| RSR-PROG-015 | Accuracy and completeness certification | The provider attests that the report data are accurate and complete. | Required checkbox / attestation Checked / certified. |
Required | Before submitting the Provider Report. | No | 2025 RSR Instruction Manual, Manual p. 64 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-SITE-001 | Name | Name of the individual service-delivery site. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every listed site. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-002 | Address type | Whether the site uses a domestic or international address. | Single select Code set ADDRESS_TYPE (2 values); see the code-set CSV. |
Required | Every listed site. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-003 | Address line 1 | Primary street-address line. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every listed site. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-004 | Address line 2 | Additional address information. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Optional | When applicable. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-005 | City | City where the site is located. | Text (formal length not specified) No formal length or pattern is published in the reviewed documents. |
Required | Every listed site. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-006 | State / province | State or province where the site is located. | State/province selection or text No formal length or pattern is published in the reviewed documents. |
Conditional | Required for a domestic address; international rules are not formally specified. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-007 | ZIP / postal code | ZIP or postal code for the site. | Postal code stored as text No formal length or pattern is published in the reviewed documents. |
Required | Every listed site under the form rules shown. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-008 | Country | Country for an international service-delivery site. | Country selection / text No formal length or pattern is published in the reviewed documents. |
Conditional | International addresses. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-009 | Phone number | Phone number clients use to access services at the site. | Phone (formal pattern not specified) No formal length or pattern is published in the reviewed documents. |
Optional | Expected for each site; missing/incomplete data create a warning. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-010 | Website URL | Web address related to the site. | URL No formal length or pattern is published in the reviewed documents. |
Optional | When a website is available; missing or invalid data create alerts. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-011 | Hours of operation | Hours when clients can access services at the site. | Structured hours / text (technical schema not specified) No formal length or pattern is published in the reviewed documents. |
Conditional | Each active site should report accurate hours; the 2025 form uses a more standardized entry method. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| RSR-SITE-012 | Services provided at this site | RWHAP, RWHAP-related, or EHE services clients can access at the site. | Multi-select Code set PROVIDER_SERVICE_CATEGORY (33 values); see the code-set CSV. |
Conditional | Each delivered/uploaded client service must be linked to at least one site. | No | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 43–47; Validation p. 3 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-AGG-001 | HIV counseling and testing services provided | Whether the organization used RWHAP, RWHAP-related, or EHE funding to provide HIV counseling and testing during the reporting period. | Single select Code set YES_NO (2 values); see the code-set CSV. |
Required | Every Provider Report. | Derived: Yes when the agency provided qualifying HC&T services during the reporting period. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 53–54; Validation p. 6 |
| RSR-AGG-002 | Individuals tested for HIV | Number of people tested with an FDA-approved HIV test during the reporting period. | Nonnegative integer Whole number 0 or greater, subject to the stated cross-field limits. |
Conditional | When HIV counseling and testing services provided = Yes. | Count / aggregate: Count qualifying individuals tested. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 54–55; Validation p. 6 |
| RSR-AGG-003 | Individuals who tested negative | Number of tested individuals whose HIV test was negative. | Nonnegative integer Whole number 0 or greater, subject to the stated cross-field limits. |
Conditional | When HIV counseling and testing services provided = Yes. | Count / aggregate: Count qualifying negative results/individuals. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 54–55; Validation p. 6 |
| RSR-AGG-004 | Individuals who tested positive | Number of tested individuals whose HIV test was positive. | Nonnegative integer Whole number 0 or greater, subject to the stated cross-field limits. |
Conditional | When HIV counseling and testing services provided = Yes. | Count / aggregate: Count qualifying positive results/individuals. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 54–55; Validation p. 6 |
| RSR-AGG-005 | Individuals testing positive who were referred to HIV medical care | Number of people with a positive test who were referred to HIV medical care. | Nonnegative integer Whole number 0 or greater, subject to the stated cross-field limits. |
Conditional | When HIV counseling and testing services provided = Yes. | Count / aggregate: Count qualifying positive individuals with a documented referral. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 54–55; Validation p. 6 |
| RSR-AGG-006 | Client residence ZIP code | ZIP code used to group reportable clients by residence. | Five-character ZIP code stored as text Most recent residence ZIP; service-site ZIP as proxy when needed; 99999 when neither residence nor proxy is known. |
Conditional | Providers reporting eligible clients in client-level data. | Derived: Assign each distinct eligible client to the most recent residence ZIP; use service-site ZIP as proxy when needed, then 99999 only if no residence or proxy exists. | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 55–57; Validation p. 7 |
| RSR-AGG-007 | Number of clients in ZIP code | Number of reportable clients assigned to the ZIP code in the row. | Positive integer Whole number greater than 0. |
Conditional | For every ZIP code row. | Count / aggregate: Count distinct reportable clients assigned to each ZIP. The sum should equal the total clients in the uploaded client-level file(s). | 2025 RSR Instruction Manual; 2025 RSR Validation Report, Manual pp. 55–57; Validation p. 7 |
| RSR-PROG-009 | MAT prescribers count | Number of physicians, nurse practitioners, or physician assistants in the funded unit/subunit who prescribed MAT for opioid use disorder during the reporting period. | Nonnegative integer Whole number; enter 0 if none. |
Required | Every Provider Report. | Count / aggregate: Count qualifying prescribers in the unit or subunit funded to provide RWHAP services, including subcontract providers. | 2025 RSR Instruction Manual, Manual pp. 49–50, 69 |
| RSR-PROG-010 | Clients treated with MAT count | Number of eligible clients treated with MAT in the funded unit/subunit during the reporting period. | Nonnegative integer Whole number; enter 0 if none. |
Required | Every Provider Report; EHE-funded providers count EHE-eligible clients. | Count / aggregate: Count eligible clients treated with MAT by the funded unit/subunit; exclude clients treated only by an outside organization. | 2025 RSR Instruction Manual, Manual pp. 49–50, 69 |
| RSR-SYS-001 | Uploaded client record count | Number of accepted client records uploaded for the provider. | Whole-number count 0 or greater |
System-tracked | Calculated after client-level XML is uploaded. | Count / aggregate: Count accepted ClientReport records, normally distinct ClientUci values after duplicate records are rejected. | RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Guide p. 21; Validation pp. 4, 7 |
| RSR-SYS-002 | Count of Clients | Number of uploaded client records that trigger one validation message. | Whole-number count 0 or greater |
System-tracked | Calculated whenever a client-level validation check runs. | Count / aggregate: For each rule, count distinct client records or ClientUci values that meet the rule’s trigger condition. | 2025 RSR Validation Report, Validation pp. 8–13 |
| ID | Field / XML path | Meaning | Type and values | Required? | When required | Derived? / how | Source |
|---|---|---|---|---|---|---|---|
| RSR-FILE-011 | ClientReport container/RSR:ROOT/ClientReport |
Contains the submitted values for one client. | Complex XML element Child elements must follow the order in the official XSD |
Required | Every reportable client. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10, Manual pp. 74–76; Guide pp. 3, 21–23 (§§3, 4) |
| RSR-CLD-003 | ClientUci/RSR:ROOT/ClientReport/ClientUci |
Encrypted identifier generated by HAB UCI tools. | Uppercase alphanumeric string 40 uppercase hexadecimal characters plus one uppercase letter |
Required | The guide requires it for every client record. The manual says all core and support services but omits EHE Initiative Services from this requirement line; confirm EHE scope against the current XSD and live RSR system. | Transformed: Generate with an approved HAB UCI/eUCI utility using the client’s full date of birth (year, month, and day), SexAtBirthID, and consistently recorded name inputs. Use complete documented names, not nicknames or initials. The result is 40 uppercase hexadecimal characters plus one A–Z suffix. The reviewed PDFs do not publish the full encryption algorithm. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 76–78, 82–83; Guide pp. 7, 21 |
| RSR-CLD-004 | VitalStatusID/RSR:ROOT/ClientReport/VitalStatusID |
Client vital enrollment status at the end of the reporting period. | Integer code Code set VITAL_STATUS (3 values); see the code-set CSV. |
Conditional | Clients receiving OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services. | Time-based selection: Use status at the end of the reporting period. If the client left care, use the last known status. If the provider’s funding ended during the year, HAB recommends using the status at the time funding ended. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 78; Guide p. 7; Validation p. 8 |
| RSR-CLD-005 | BirthYear/RSR:ROOT/ClientReport/BirthYear |
Client year of birth. | Four-digit year Valid calendar year meeting the date rules |
Required | Every reportable client. | Derived: Extract YYYY from the locally held full date of birth; only the year is submitted. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 78–79; Guide pp. 7–8; Validation pp. 8, 13 |
| RSR-CLD-006 | EthnicityID/RSR:ROOT/ClientReport/EthnicityID |
Client ethnicity. | Integer code Code set ETHNICITY (2 values); see the code-set CSV. |
Required | Every reportable client. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 79–80; Guide p. 8 |
| RSR-CLD-007 | ClientReportHispanicSubgroup/SubgroupID/RSR:ROOT/ClientReport/ClientReportHispanicSubgroup/SubgroupID |
Hispanic subgroup; report all that apply. | Integer code; multi-select Code set HISPANIC_SUBGROUP (4 values); see the code-set CSV. |
Conditional | When EthnicityID = 1 (Hispanic/Latino/a). | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 80; Guide p. 8 |
| RSR-CLD-008 | ClientReportRace/RaceID/RSR:ROOT/ClientReport/ClientReportRace/RaceID |
Client race; report all that apply. | Integer code; multi-select Code set RACE (5 values); see the code-set CSV. |
Required | Every reportable client; report all races that apply. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 80–81; Guide pp. 8–9 |
| RSR-CLD-009 | ClientReportAsianSubgroup/SubgroupID/RSR:ROOT/ClientReport/ClientReportAsianSubgroup/SubgroupID |
Asian subgroup; report all that apply. | Integer code; multi-select Code set ASIAN_SUBGROUP (7 values); see the code-set CSV. |
Conditional | When RaceID = 3 (Asian). | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 81–82; Guide p. 9 |
| RSR-CLD-010 | ClientReportNhpiSubgroup/SubgroupID/RSR:ROOT/ClientReport/ClientReportNhpiSubgroup/SubgroupID |
NHPI subgroup; report all that apply. | Integer code; multi-select Code set NHPI_SUBGROUP (4 values); see the code-set CSV. |
Conditional | When RaceID = 4 (Native Hawaiian/Pacific Islander). | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 82; Guide pp. 9–10 |
| RSR-CLD-011 | SexAtBirthID/RSR:ROOT/ClientReport/SexAtBirthID |
Biological sex assigned at birth. | Integer code Code set SEX_AT_BIRTH (3 values); see the code-set CSV. |
Required | Every reportable client. The value may be Unknown, but the element may not be missing. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 7, 82–83; Guide p. 10; Validation p. 8 |
| RSR-CLD-012 | PovertyLevelPercent/RSR:ROOT/ClientReport/PovertyLevelPercent |
Client percentage of the federal poverty level at end of reporting period. | Integer Integer up to four digits; no decimals |
Conditional | Clients receiving OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services. | Calculated: Calculate income as a percent of the applicable federal poverty measure and report a whole number up to four digits. HAB prefers HHS guidelines unless the agency already uses Census thresholds. Use the latest value on file; an earlier-year collection does not need to be repeated at year end, but changes should be documented. The documents do not give the full household-size or rounding procedure. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 83; Guide p. 10; Validation p. 8 |
| RSR-CLD-013 | HousingStatusID/RSR:ROOT/ClientReport/HousingStatusID |
Housing status at end of reporting period. | Integer code Code set HOUSING_STATUS (3 values); see the code-set CSV. |
Conditional | Clients receiving OAHS, Medical Case Management, Non-Medical Case Management, Housing Services, or EHE Initiative Services. | Derived: Classify the latest living arrangement using the Stable/permanent, Temporary, and Unstable definitions in the manual. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 84–85; Guide pp. 10–11; Validation p. 9 |
| RSR-CLD-014 | HousingStatusCollectedDate/RSR:ROOT/ClientReport/HousingStatusCollectedDate |
Date when end-of-period housing status was collected. | Date serialized as string A valid collection date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | Same client/service scope as HousingStatusID. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 85–86; Guide p. 11; Validation p. 9 |
| RSR-CLD-015 | HivAidsStatusID/RSR:ROOT/ClientReport/HivAidsStatusID |
HIV/AIDS status at end of reporting period. | Integer code Code set HIV_STATUS (5 values); see the code-set CSV. |
Conditional | Clients receiving OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services. For an HIV-affected client whose HIV status is unknown, omit this tag. | Derived: Classify the status at year end; once CDC-defined AIDS, continue reporting CDC-defined AIDS. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 86–87; Guide p. 11; Validation pp. 8–9, 11–13 |
| RSR-CLD-016 | ClientReportHivRiskFactor/HivRiskFactorID/RSR:ROOT/ClientReport/ClientReportHivRiskFactor/HivRiskFactorID |
Initial HIV risk factor; report all that apply. | Integer code; multi-select Code set HIV_RISK_FACTOR (7 values); see the code-set CSV. |
Conditional | Clients receiving OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services; omit for an affected client whose HIV status is unknown. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 87–88; Guide pp. 11–12; Validation p. 8 |
| RSR-CLD-017 | ClientReportHealthCoverage/MedicalInsuranceID/RSR:ROOT/ClientReport/ClientReportHealthCoverage/MedicalInsuranceID |
Health coverage; report all that apply. | Integer code; multi-select Code set HEALTH_COVERAGE (8 values); see the code-set CSV. |
Conditional | Clients receiving any core medical service, Non-Medical Case Management, or EHE Initiative Services. | Time-based classification: Report every coverage source held during any part of the year. Also report No insurance when the client was uninsured at any time, even if another plan applied during another part of the year. Classify COBRA as Private–Employer and exchange coverage as Private–Individual. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 88–90; Guide p. 12; Validation p. 9 |
| RSR-CLD-018 | HivDiagnosisYear/RSR:ROOT/ClientReport/HivDiagnosisYear |
Year of HIV diagnosis, if known. | Four-digit year Valid diagnosis year |
Conditional | A new client receiving OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services when HIV status is neither negative nor indeterminate; report if known. | Derived: Extract the year from the documented HIV diagnosis date. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 90; Guide pp. 12–13; Validation pp. 8, 13 |
| RSR-CLD-019 | NewClient/RSR:ROOT/ClientReport/NewClient |
Whether the client is new to care at this service provider. | Integer code Code set YES_NO_NUMERIC (2 values); see the code-set CSV. |
Conditional | Clients of an EHE Initiative-funded provider who received a core medical, support, or EHE service. The guide says All; the manual narrows this to EHE-funded providers. | Derived: Yes only when the person has never received care from this HIV services provider. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 90–91; Guide p. 13; Validation p. 9 |
| RSR-CLD-020 | ReceivedServicePreviousYear/RSR:ROOT/ClientReport/ReceivedServicePreviousYear |
Whether client received at least one service in the prior year. | Integer code Code set YES_NO_NUMERIC (2 values); see the code-set CSV. |
Conditional | Clients of an EHE Initiative-funded provider when NewClient = No and the client received OAHS, Medical Case Management, Non-Medical Case Management, or EHE Initiative Services. | Derived: Yes when at least one provider service occurred in the calendar year immediately before the report year. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 91–92; Guide p. 13; Validation p. 9 |
| RSR-CLD-021 | ClientReportServiceVisits/ServiceVisit/ServiceID/RSR:ROOT/ClientReport/ClientReportServiceVisits/ServiceVisit/ServiceID |
Identifies each visit-based service received during the reporting period. | Integer code Code set SERVICE_VISIT_ID (26 values); see the code-set CSV. |
Conditional | For each core medical, support, or EHE service category with at least one actual visit day. | Derived: Map the service record to the allowed ServiceID. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 92–94; Guide pp. 14–15; Validation pp. 3, 5, 10 |
| RSR-CLD-022 | ClientReportServiceVisits/ServiceVisit/Visits/RSR:ROOT/ClientReport/ClientReportServiceVisits/ServiceVisit/Visits |
Number of service visit days in the period for the indicated category. | Integer Whole number 1 through 365 |
Conditional | With each reported service-visit ServiceID. | Count / aggregate: Count distinct calendar days per client and service category. Multiple same-category services on one day count once; omit zero-visit categories. If client eligibility has a gap, count only visits during eligible periods. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 92–94, 102; Guide pp. 14–15; Validation p. 10 |
| RSR-CLD-023 | ClientReportServiceDelivered/ServiceDelivered/ServiceID/RSR:ROOT/ClientReport/ClientReportServiceDelivered/ServiceDelivered/ServiceID |
Identifies each delivered core service that is reported as an indicator rather than visit count. | Integer code Code set SERVICE_DELIVERED_ID (2 values); see the code-set CSV. |
Conditional | When AIDS Pharmaceutical Assistance or Health Insurance Premium and Cost-Sharing Assistance was delivered. | Derived: Map the delivered non-visit service to ServiceID 9 or 12. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 94–95; Guide pp. 15–16; Validation pp. 3, 5, 10 |
| RSR-CLD-024 | ClientReportServiceDelivered/ServiceDelivered/DeliveredID/RSR:ROOT/ClientReport/ClientReportServiceDelivered/ServiceDelivered/DeliveredID |
States that the paired ServiceID was delivered. | Integer code Code set DELIVERED_YES (1 values); see the code-set CSV. |
Conditional | With each reported ServiceDelivered ServiceID. | Derived: Use the fixed value 2 (Yes) when the service was delivered; omit undelivered services. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 94–95; Guide pp. 15–16; Validation pp. 3, 5, 10 |
| RSR-CLD-025 | FirstAmbulatoryCareDate/RSR:ROOT/ClientReport/FirstAmbulatoryCareDate |
Date of first ambulatory HIV care at this provider. | Date serialized as string Valid date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | HIV-positive clients receiving OAHS; not required for HIV-indeterminate infants under age 2. | Derived: Use the earliest qualifying HIV OAHS visit with this provider; if the true first date cannot reasonably be found, use the earliest available record. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 95–96, 102; Guide pp. 16–17; Validation pp. 8, 11–12 |
| RSR-CLD-026 | ClientReportAmbulatoryService/ServiceDate/RSR:ROOT/ClientReport/ClientReportAmbulatoryService/ServiceDate |
All OAHS visit dates in the provider's HIV care setting during the reporting period. | Date serialized as string One date per distinct qualifying visit day; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | HIV-positive clients receiving OAHS; not required for HIV-indeterminate infants under age 2. | Filtered list: Report one date for every distinct qualifying OAHS visit day during the full year, regardless of payor. The number of dates should equal the Element 16 OAHS visit count. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 96, 102; Guide p. 17; Validation pp. 8, 10–12 |
| RSR-CLD-027 | ClientReportCd4Test/Cd4Test/Count/RSR:ROOT/ClientReport/ClientReportCd4Test/Cd4Test/Count |
CD4 result during reporting period. | Integer Integer; no formal lower or upper schema bound is published |
Conditional | HIV-positive clients receiving OAHS; not required for HIV-indeterminate infants under age 2. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 96–97, 102; Guide pp. 17–18; Validation pp. 8, 11–12 |
| RSR-CLD-028 | ClientReportCd4Test/Cd4Test/ServiceDate/RSR:ROOT/ClientReport/ClientReportCd4Test/Cd4Test/ServiceDate |
Date of CD4 specimen/test in the reporting period. | Date serialized as string Valid date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | With each reported CD4 Count. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 96–97, 102; Guide pp. 17–18; Validation pp. 11–12 |
| RSR-CLD-029 | ClientReportViralLoadTest/ViralLoadTest/Count/RSR:ROOT/ClientReport/ClientReportViralLoadTest/ViralLoadTest/Count |
Viral load result during reporting period. | Integer Integer copies/mL; use the assay lower bound, or 0 when an undetectable result has no known bound |
Conditional | HIV-positive clients receiving OAHS; not required for HIV-indeterminate infants under age 2. | Transformed: Report integer copies/mL. Convert log result L as 10^L. For undetectable results, use the assay lower bound or 0 if the bound is unavailable. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 97–98, 102; Guide pp. 18–19; Validation pp. 8, 11–12 |
| RSR-CLD-030 | ClientReportViralLoadTest/ViralLoadTest/ServiceDate/RSR:ROOT/ClientReport/ClientReportViralLoadTest/ViralLoadTest/ServiceDate |
Date of viral load specimen/test in the reporting period. | Date serialized as string Valid date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | With each reported viral-load Count. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 97–98, 102; Guide pp. 18–19; Validation pp. 11–12 |
| RSR-CLD-031 | PrescribedArtID/RSR:ROOT/ClientReport/PrescribedArtID |
Whether ART was prescribed at any time during the period. | Integer code Code set PRESCRIBED_ART (2 values); see the code-set CSV. |
Conditional | HIV-positive clients receiving OAHS; not required for HIV-indeterminate infants under age 2. | Derived: Yes when ART began or continued at any time in the reporting period; otherwise No. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 98, 102; Guide p. 19; Validation p. 12 |
| RSR-CLD-032 | ScreenedSyphilisID/RSR:ROOT/ClientReport/ScreenedSyphilisID |
Whether the client was screened for syphilis during the reporting period. | Integer code Code set SYPHILIS_SCREEN (3 values); see the code-set CSV. |
Conditional | HIV-positive clients receiving OAHS; use Not medically indicated when appropriate. The guide separately mentions age 18 or older. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 98, 102; Guide pp. 19–20 |
| RSR-CLD-033 | PregnantID/RSR:ROOT/ClientReport/PregnantID |
Whether the client was pregnant during the reporting period. | Integer code Code set PREGNANCY_STATUS (3 values); see the code-set CSV. |
Conditional | HIV-positive OAHS clients whose SexAtBirthID is Female; not required for HIV-indeterminate infants under age 2. | No | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 99, 102; Guide p. 20; Validation p. 8 |
| RSR-CLD-034 | HivPosTestDate/RSR:ROOT/ClientReport/HivPosTestDate |
Date of positive confirmatory HIV test. | Date serialized as string Valid date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | Newly diagnosed OAHS clients with a documented positive test during the reporting period. | Derived: Use the first documented positive test date. A documented test from another site is acceptable; client self-report alone is not. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual p. 99, 102; Guide p. 20; Validation p. 13 |
| RSR-CLD-035 | OamcLinkDate/RSR:ROOT/ClientReport/OamcLinkDate |
First OAHS visit after positive HIV test. | Date serialized as string Valid date; Guide examples use mm,dd,yyyy; the manual shows MM/DD/YYYY. Confirm the current XSD. |
Conditional | Newly diagnosed OAHS clients; first qualifying OAHS visit on or after the positive test, within the reporting period. | Derived: Use the first qualifying OAHS medical visit with a prescribing provider on or after HivPosTestDate. | 2025 RSR Instruction Manual; RSR XML Implementation Guide v3.10; 2025 RSR Validation Report, Manual pp. 99–100, 102; Guide pp. 20–21; Validation p. 13 |