ADR data dictionary

Source note: Required file structure, not a client value.

Source note: The guide p. 2 root example includes xsi:schemaLocation; the collapsed sample on p. 24 omits it. Confirm the current XSD and accepted root attributes.

Source note: This is the only complex element that the guide says does not use a CLD_ID attribute.

Source note: Guide document version 3.7 and XML schema version 3.4.0 are different version numbers.

Source note: The guide gives < and > as examples, but does not enumerate the complete excluded-character set.

Source note: The guide gives < and > as examples, but does not enumerate the complete excluded-character set.

Source note: The guide gives < and > as examples, but does not enumerate the complete excluded-character set.

Source note: The schema example wraps across lines in the PDF; use the full tag name without breaks.

Source note: The allowed-value pattern is literal. The guide example 123,456,789 does not match that pattern and should not be copied.

Source note: Display-only. The reviewed documents do not publish a web-form technical schema or formal length limit.

Source note: Display-only. Preserve leading letters or zeros. The reviewed documents do not publish a formal pattern.

Source note: Display-only. The manual calls this a “12-digit alphanumeric identifier”; “12-character alphanumeric” is used here for clarity.

Source note: The web form displays the full address as one display-only line. This dictionary separates common address parts so implementers can map their source data; the reviewed documents do not publish the underlying address subfields.

Source note: The web form displays the full address as one display-only line. This dictionary separates common address parts so implementers can map their source data; the reviewed documents do not publish the underlying address subfields.

Source note: The web form displays the full address as one display-only line. This dictionary separates common address parts so implementers can map their source data; the reviewed documents do not publish the underlying address subfields.

Source note: The web form displays the full address as one display-only line. This dictionary separates common address parts so implementers can map their source data; the reviewed documents do not publish the underlying address subfields.

Source note: Editable in the web form. The screenshot marks Contact Name, Contact Title, Contact Email, and Contact Telephone as required; Contact Telefax is not marked required.

Source note: Editable in the web form. The screenshot marks Contact Name, Contact Title, Contact Email, and Contact Telephone as required; Contact Telefax is not marked required.

Source note: Editable in the web form. The screenshot marks Contact Name, Contact Title, Contact Email, and Contact Telephone as required; Contact Telefax is not marked required.

Source note: Editable in the web form. The screenshot marks Contact Name, Contact Title, Contact Email, and Contact Telephone as required; Contact Telefax is not marked required.

Source note: Editable in the web form. The screenshot marks Contact Name, Contact Title, Contact Email, and Contact Telephone as required; Contact Telefax is not marked required.

Source note: Question 1 allows more than one cost-control limit. If no listed limit applied, select only “None of these limits.”

Source note: Question 1 allows more than one cost-control limit.

Source note: The manual does not publish a numeric range or separate validation check.

Source note: Question 1 allows more than one cost-control limit.

Source note: The manual does not publish a numeric range or separate validation check.

Source note: Question 1 allows more than one cost-control limit.

Source note: The manual does not state whether cents are accepted for this field.

Source note: The screenshot labels the choices “Per Month” and “Annual”; the narrative says monthly or annually.

Source note: Question 1 allows more than one cost-control limit.

Source note: No complete medication value list or web-form technical schema is included in the reviewed repository sources.

Source note: Question 1 allows more than one cost-control limit.

Source note: Question 1 allows more than one cost-control limit.

Source note: Mutually exclusive: this must be the only Question 1 response when selected.

Source note: If medication and health coverage services use different FPL limits, report the medication-services limit. The manual links to HHS Poverty Guidelines for determining FPL but this field is the program policy threshold, not a value calculated from submitted client records.

Source note: “Unexpected” is defined by the recipient’s own anticipated or projected enrollment.

Source note: This is entered by the recipient; the source does not say the system calculates it from client records.

Source note: Question 4 says to check all options that apply. Prime Vendor is shown as a nested choice under 340B Direct Purchase.

Source note: Question 4 says to check all options that apply. Prime Vendor is shown as a nested choice under 340B Direct Purchase.

Source note: Question 4 says to check all options that apply. Prime Vendor is shown as a nested choice under 340B Direct Purchase.

Source note: Question 4 says to check all options that apply. Prime Vendor is shown as a nested choice under 340B Direct Purchase.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here. The funding-guidance table on Manual p. 21 mistakenly tells readers to report this under item “e,” although the numbered question and screenshot place it at Q5d.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here. The narrative heading on Manual p. 21 shortens this to “Manufacturer Reinvested in ADAP,” while the screenshot and explanatory text identify manufacturer rebates and reinvested program income.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: Do not leave blank. The manual says it is possible to enter 0 for all eight sources, while Check 14 warns when their total is 0. Part B base, Part B supplemental, ADAP base, ADAP Emergency Relief Funds, and the ADAP Flexibility Policy are not reported here.

Source note: The screenshot shows this read-only-looking total. Automatic calculation is inferred from that presentation and the explicit “Total of a through h” label; unlike the expenditure total, the narrative does not expressly say it is calculated automatically. The manual permits all eight source values to be 0, while Check 14 produces a warning when the sum is 0.

Source note: Do not leave blank. Negotiated rates and fees should be assigned to the category they cover. The manual provides a cost-classification table on p. 23.

Source note: Do not leave blank. Negotiated rates and fees should be assigned to the category they cover. The manual provides a cost-classification table on p. 23.

Source note: Do not leave blank. Negotiated rates and fees should be assigned to the category they cover. The manual provides a cost-classification table on p. 23.

Source note: Do not leave blank. Negotiated rates and fees should be assigned to the category they cover. The manual provides a cost-classification table on p. 23.

Source note: The manual explicitly states that the system calculates this total.

Source note: An open formulary covers all FDA-approved drugs with some limited exceptions.

Source note: The complete, changeable medication option list is not printed in the manual. Select All may populate the list for an open formulary.

Source note: When a medication was added before the reporting period but is missing from the ADR list, select Med Added but do not enter a Date Added.

Source note: The manual does not publish a formal date display pattern. Check 19 names only Q7a ARV dates; no separate date validation is listed for Q7b or Q7c.

Source note: The complete, changeable medication option list is not printed in the manual. Select All may populate the list for an open formulary. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: When a medication was added before the reporting period but is missing from the ADR list, select Med Added but do not enter a Date Added. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: The manual does not publish a formal date display pattern. Check 19 names only Q7a ARV dates; no separate date validation is listed for Q7b or Q7c. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: The complete, changeable medication option list is not printed in the manual. Select All may populate the list for an open formulary. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: When a medication was added before the reporting period but is missing from the ADR list, select Med Added but do not enter a Date Added. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: The manual does not publish a formal date display pattern. Check 19 names only Q7a ARV dates; no separate date validation is listed for Q7b or Q7c. Mapping Q7b to A1-OI and Q7c to the combined hepatitis B/C list follows the order of the three list categories in the manual; only Q7a is explicitly labeled in Figure 11.

Source note: Included to distinguish a system-calculated recipient-level total from submitted data. It should not be serialized as an XML element.

Source note: The guide says the CLD_ID attribute links a client and child records. Empty or null tags are prohibited; omit an optional element when no value is available. Guide p. 3 can be read as placing the complex elements as siblings under CLD:ROOT after an unclosed AdrClientReport tag, while the later revised sample on pp. 24–26 nests them inside AdrClientReport. This dictionary follows the later nested sample; confirm the hierarchy against the current XSD.

Source note: Container only; each submitted race code is recorded in ADR-CLD-003.

Source note: Container only; repeat SubgroupId inside it for every applicable choice.

Source note: Container only; repeat SubgroupId inside it for every applicable choice.

Source note: The manual capitalizes “SubGroup”; the guide data table uses “Subgroup.” Confirm exact capitalization against the XSD.

Source note: Guide v3.7’s section and expanded sample use HealthCoverage, while the earlier body example still prints the removed MedicalInsurance name.

Source note: The guide’s wording “required only if DisenrollmentReasonId is true” is circular; the manual supplies the controlling condition.

Source note: The guide says the outer container occurs 0–N, while its sample uses one outer container with multiple Medication records. Confirm the XSD nesting and occurrence.

Source note: Guide element tables name AdrClientReportMedication as the parent; the expanded sample shows an additional Medication record wrapper. Confirm against the XSD.

Source note: The section heading uses CD4 in capitals; the expanded sample uses Cd4 and contains a misspelled closing tag. Confirm exact tag case with the XSD.

Source note: This inner record appears in the expanded sample but is not separately defined in section 3.1.

Source note: The guide’s complex-element Variable Name omits “Test,” but its schema and sample include it. Use the XSD to settle the exact name.

Source note: This inner record appears in the expanded sample but is not separately defined in section 3.1.

Source note: The container appears in the expanded guide sample and as the parent of InsuranceAssistanceTypeId, but is omitted from the guide’s complex-element section.

Source note: Guide section 3.1 names AdrClientReport, AdrClientReportRace, AdrClientReportHealthCoverage, AdrClientReportDisenrollmentReason, AdrClientReportMedication, AdrClientReportCD4Test, and AdrClientReportViralLoadTest as the applicable client complex elements. It does not establish CLD_ID placement on inferred inner record wrappers, subgroup containers, or the insurance-assistance container, and the revised samples omit the attribute.

Source note: Manual p. 29 calls the eUCI 40 characters, while the guide describes a 40-character SHA-1 value plus one suffix (41 total). The full collision-suffix algorithm is not published in the reviewed documents; use an approved utility. Changing a name, full DOB, or sex at birth changes the eUCI.

Source note: The manual requires this for all clients; the guide says Required=No even though occurrence is 1 per client. Follow the manual’s reporting requirement. Unknown is not an active response and exports as missing.

Source note: Canonical ID 5 comes from the implementation guide and manual Appendix A. Manual Table 1/body and the CAREWare supplement incorrectly call race ID 6; ID 6 is the removed Gender field according to Manual p. 3. Unknown is not an active response.

Source note: The guide calls the complex container the element but its schema shows repeated SubgroupId leaves. There is no Unknown code; missing data remain blank/omitted.

Source note: Manual text refers to race ID 5 here, supporting ID 5 as the canonical race identifier. There is no Unknown subgroup code.

Source note: The manual and guide differ in capitalization of Subgroup. XML tag names are case-sensitive; confirm the current XSD.

Source note: Submit code 4 for Unknown, but use code 9 for Unknown only while constructing the UCI/eUCI input. This field replaces removed Gender ID 6.

Source note: Only the year is submitted, but the full date is required locally to generate a stable eUCI.

Source note: Manual requires the field for all clients; guide labels it Required=No. Validation check 103 still warns on missing/invalid values. HIV dates in CAREWare must precede year end.

Source note: Manual requires the value for all clients; guide labels it Required=No. This is a calculation, but the reviewed materials do not specify household-income composition, guideline family-size lookup details, or rounding. CAREWare calculates it after inputs are entered.

Source note: Manual scenarios map Marketplace coverage and Medigap to Private—Individual, COBRA to Private—Employer, Medicare Advantage to Medicare Part C, Medicaid limited coverage to Medicaid/CHIP/other public, and employer self-insurance to Other Plan. Guide occurrence 1–11 conflicts with its 12 active codes and the manual’s report-all rule.

Source note: Service use is not required for enrollment. Manual requires this field for all clients; guide labels it Required=No.

Source note: Manual says required only for newly enrolled clients whose application was approved during 2025. Guide broadens this to all newly enrolled clients. The date-delimiter conflict requires confirmation against the 3.4.0 XSD.

Source note: Manual requires approval within 2025. Guide says on/before period end and gives a 2014 example, conflicting with the manual and validation 48. Use the manual rule. Confirm XML date delimiter against the XSD.

Source note: High-priority conflict: the authoritative 2025 manual explicitly removes ID 17, but guide v3.7 calls it Revised and includes it, and the January 2026 validations retain check 112. Treat it as removed and confirm against the actual schema 3.4.0 or HAB before implementation.

Source note: Manual requires the field for all clients; guide labels it Required=No. Capitalization and spelling differ across the reviewed PDFs; confirm the XSD tag.

Source note: Report all applicable reasons except that Unknown cannot be combined. Use client eligibility changed for moving out of state or income rising above the state limit. Guide allows only 1–6 values even though seven non-Unknown codes are listed; confirm XSD cardinality.

Source note: Manual requires this for every client and says No must be reported when no service was received; guide labels it Required=No. Medical-visit co-pays are generally not reported here.

Source note: For 2025, separate Full Premium and Partial Premium options were replaced by code 4. The guide schema example incorrectly uses code 1; only codes 3 and 4 are active.

Source note: Manual and validations make the amount type-specific. Guide says required whenever any insurance assistance was received and permits zero, which is broader and conflicts with checks 109–110. Follow type-specific manual/validation logic.

Source note: Unresolved numeric conflict: guide allows 0–15, while check 108 flags values outside 1–18 and the CAREWare guide says totals should normally be 1–18. Manual provides no ceiling and explicitly allows months beyond the reporting period.

Source note: Manual makes the amount conditional on type 3; guide broadly says any insurance assistance. Manual text says a total below $0.50 rounds to $1, while its common-issues table and CAREWare supplement say any positive amount below $1 rounds to $1; the latter prevents reporting a positive service as zero.

Source note: Medication cost-sharing paid under insurance is not medication assistance. Manual requires this flag for every client; guide labels it Required=No.

Source note: The reviewed PDFs do not include the MedicationLkup/NDC reference table, so the complete active NDC list cannot be reproduced here. Use the current lookup supplied by HAB or ADR-ready software.

Source note: Use the actual dispense date and exclude reversed claims. Manual and guide disagree on slash versus comma separators; confirm against the 3.4.0 XSD.

Source note: Guide supplies the formal 1–360 range; manual says use one day when the item has no days supply.

Source note: Cost is per medication per dispense, not an annual client aggregate. Guide permits zero; manual service rules say a positive cost is required and positive values below $1 become 1.

Source note: Use specimen/blood-draw date, not the date the lab result was posted. Date separator differs between manual and guide; confirm the XSD.

Source note: Unresolved range conflict: the manual, guide, and CAREWare supplement allow values through 5000, but validation 118 warns above 3000. Values 3001–5000 are documented as allowed yet will trigger a quality warning.

Source note: Use specimen/blood-draw date, not the date the result was posted. Date separator differs between manual and guide; confirm the XSD.

Source note: The reviewed documents require conversion from log units but do not state a rounding rule after conversion; submit an integer that meets the XSD.