Information Technology Support Services
Acquired Immune Deficiency Syndrome (AIDS)
Drug Assistance Program (ADAP) Data Reports
(ADR) Release 4.0 XML Schema Implementation
Guide
Date Last Updated: March 10 2016
Prepared for:
Health Resources and Services Administration
HIV/AIDS Bureau
5600 Fishers Lane
Rockville, MD 20857
Prepared by:
Health Informatics & Infrastructure Solutions
6710 B Rockledge Drive, Suite 510
Bethesda, MD 20817
ADR 4.0 Release
XML Schema Implementation Guide
ii
Document Version History
Version
Date
Description
1.0
6/23/2014
ADR 3.0 Release
1.1
12/12/2014
Revised to indicate whether data elements are required, to match the
XML schema, and to update fields, as necessary.
1.2
12/16/2014
Added the document version number.
2.0
2/23/2016
The following updates were addressed in this version:
• Removed the following tables since these elements were removed
during the ADR 3.0 release:
o ReportPeriodId
o ADAPNumber
o MedicationDispensingFeeFlag
o MedicationDispensingFeeAmount
• Changed the maximum allowed value for Medication Cost (item 29)
from 20,000 to 100,000.
• Changed the document title to “ADR XML Schema Implementation
Guide Release 4.0”.
• Applied updates to the URLs in Appendix A – Resources.
• Applied updates to meet HRSA guidelines for document to be 508-
compliant.
ADR 4.0 Release
XML Schema Implementation Guide
iii
Table of Contents
1 INTRODUCTION ......................................................................................................... 1
1.1 Purpose ................................................................................................................ 1
1.2 Audience .............................................................................................................. 1
1.3 Structure of This Document .................................................................................. 1
2 OVERVIEW OF THE ADR CLIENT-LEVEL DATA XML FILE ................................... 2
2.1 Main Components of the Client-Level Data XML File ........................................... 2
2.1.1 File Header ................................................................................................ 2
2.1.2 Root Element ............................................................................................. 2
2.1.3 Body Elements ........................................................................................... 3
3 ADR CLIENT-LEVEL XML DATA ELEMENTS .......................................................... 4
3.1 Complex Elements ............................................................................................... 5
3.1.1 AdrClientReportXmlVersion ....................................................................... 5
3.1.2 AdrClientReport ......................................................................................... 5
3.1.3 AdrClientReportRace ................................................................................. 5
3.1.4 AdrClientReportMedicalInsurance ............................................................. 6
3.1.5 AdrClientReportDisenrollmentReason ....................................................... 6
3.1.6 AdrClientReportMedication ........................................................................ 6
3.2 Simple Elements ................................................................................................... 7
3.2.1 XML Schema Version Elements ................................................................ 7
3.2.1.1 AdrSchemaVersion ............................................................................................ 7
3.2.1.2 Vendor ............................................................................................................... 7
3.2.1.3 VendorVersionNumber ....................................................................................... 8
3.2.1.4 VendorTechnicalContactName ........................................................................... 8
3.2.1.5 VendorTechnicalContactEmail ........................................................................... 8
3.2.1.6 VendorTechnicalContactPhone .......................................................................... 8
3.2.2 System Variables Elements ....................................................................... 9
3.2.2.1 ClientUci ............................................................................................................. 9
3.2.3 Client Demographics Elements .................................................................. 9
3.2.3.1 EthnicityId .......................................................................................................... 9
3.2.3.2 RaceId .............................................................................................................. 10
3.2.3.3 AdrClientReportHispanicSubgroup ................................................................... 10
3.2.3.4 AdrClientReportAsianSubgroup ........................................................................ 10
3.2.3.5 AdrClientReportNhpiSubgroup ......................................................................... 11
3.2.3.6 GenderId .......................................................................................................... 11
3.2.3.7 TransgenderId .................................................................................................. 12
ADR 4.0 Release
XML Schema Implementation Guide
iv
3.2.3.8 SexAtBirthId ..................................................................................................... 12
3.2.3.9 BirthYear .......................................................................................................... 12
3.2.3.10 HivAidsStatusId ................................................................................................ 13
3.2.3.11 PovertyLevelId ................................................................................................. 13
3.2.3.12 HighRiskInsuranceId ........................................................................................ 13
3.2.3.13 MedicalInsuranceId .......................................................................................... 14
3.2.4 Enrollment and Certification Elements ..................................................... 14
3.2.4.1 NewEnrollmentFlag .......................................................................................... 14
3.2.4.2 ApplicationReceivedDate ................................................................................. 15
3.2.4.3 ApplicationApprovalDate .................................................................................. 15
3.2.4.4 RecertificationDate ........................................................................................... 15
3.2.4.5 EnrollmentStatusId ........................................................................................... 16
3.2.4.6 DisenrollmentReasonId .................................................................................... 16
3.2.5 Insurance Services Elements .................................................................. 17
3.2.5.1 InsuranceAssistanceReceivedFlag ................................................................... 17
3.2.5.2 InsuranceAssistanceType ................................................................................ 17
3.2.5.3 InsurancePremiumAmount ............................................................................... 18
3.2.5.4 InsurancePremiumMonthCount ........................................................................ 18
3.2.5.5 InsuranceDeductibleAndCopayAmount ............................................................ 18
3.2.6 Drug and Drug Expenditure Elements ..................................................... 19
3.2.6.1 MedicationsDispensedFlag .............................................................................. 19
3.2.6.2 MedicationId ..................................................................................................... 19
3.2.6.3 MedicationStartDate ......................................................................................... 19
3.2.6.4 MedicationDays ................................................................................................ 20
3.2.6.5 MedicationCost ................................................................................................ 20
3.2.7 Clinical Elements ..................................................................................... 21
3.2.7.1 LastCd4Date .................................................................................................... 21
3.2.7.2 LastCd4Count .................................................................................................. 21
3.2.7.3 LastViralLoadDate ............................................................................................ 21
3.2.7.4 LastViralLoadCount .......................................................................................... 22
4 ADR CLIENT-LEVEL DATA XML FILE FORMAT ................................................... 22
4.1 Validation Checks to Pass before File Is Accepted by ADR Web Application .... 22
4.2 Sample XML File Format – Collapsed ................................................................ 23
4.3 Sample XML File Format – Expanded ................................................................ 24
APPENDIX A: RESOURCES ...................................................................................... 28
A.1 ADR Client XML Schema Definition Files ........................................................... 28
A.2 TRAX (XML Generator) ...................................................................................... 28
A.3 TARGET Center Website ................................................................................... 28
APPENDIX B: ACRONYMS ........................................................................................ 29
ADR 4.0 Release
XML Schema Implementation Guide
v
ADR 4.0 Release
XML Schema Implementation Guide
1
1 Introduction
Grantees must submit Acquired Immune Deficiency Syndrome (AIDS) Drug Assistance
Program (ADAP) Data Reports (ADR) to the Health Resources Services Administration's
(HRSA) Human Immunodeficiency Virus (HIV)/AIDS Bureau (HAB) annually. To submit the
ADR successfully, each grantee must complete the online section of the grantee report and
create and upload one or more Extensible Markup Language (XML) files containing client-level
data. The structure, sequence, values, and format of the data elements must conform to the
definitions specified in this document. The client-level data XML file must then be uploaded to
the ADR web application, where it is validated for conformance to the data schema and
business rules. For instructions on how to upload the ADR client-level data XML files to the
ADR web application, please see the ADR Instruction Manual available on the TARGET website
(ADR Instruction Manual
).
1.1 Purpose
The purpose of this document is to provide reference information to grantees on the allowable
structure, sequence, values, and format of the ADR client-level data XML files. Grantees may
use this information to be better prepared when they create their own applications and/or
processes to extract the appropriate data from their data sources and convert it to the required
XML format. All ADR client-level data XML files must conform to the definitions in this
document.
The goal of this document is to help grantees reduce and/or avoid errors that may result when
they generate and submit client-level data XML files to the ADR web application. This
document includes data definitions that describe the meaning of each element in the ADR
client-level data XML files. In addition, this document describes the required format of the XML
file, provides examples of XML files, and includes references to the XML schema definitions that
are used to validate the XML file. For grantees that are using the same application for
submitting their Ryan White Services Report, the coding for similar data element values (such
as demographics) for the ADR are consistent.
1.2 Audience
This document is intended for ADAP technical and/or administrative staff that must collect and
report ADR client-level data elements in an XML file format to HRSA's HAB. Staff may include
developers, data quality specialists, ADAP Administrators, or other individuals who are
responsible for generating and submitting the ADR.
1.3 Structure of This Document
This document contains the following sections:
• Section 1: Introduction describes the purpose of the XML Schema Implementation Guide.
• Section 2: Overview of the ADR Client-Level Data XML File describes the main
components of the ADR client-level data XML file.
ADR 4.0 Release
XML Schema Implementation Guide
2
• Section 3: ADR Client-Level Data Elements defines the individual client-level data
elements required in the XML file.
• Section 4: ADR Client-Level Data XML File Format provides the the validation checks
that the XML file must pass before the file Is accepted by the ADR web application as well
as sample XML files.
• Appendix A: Resources contains a list of available resources, including the ADR client-
level data XML schema definitions, sample XML files, and an ADR client-level data XML
generation tool.
• Appendix B: Acronyms contains a list of acronyms used in this document and their
definitions.
2 Overview of the ADR Client-Level Data XML File
As mentioned in the introduction, grantees must submit ADR client-level data to the ADR web
application on an annual basis. The required file format for submitting the ADR report is XML.
XML is a structured document standard for defining a file format, as well as for specifying
allowed data element values, data element sequence, and the number of occurrences for data
elements. XML is a platform-independent language that simplifies the process of exchanging
data in a standardized way over the Internet between different applications.
2.1 Main Components of the Client-Level Data XML File
The ADR client-level data XML file consists of three components:
1) File Header.
2) Root Element.
3) Body Elements.
Body elements consist of both complex and simple data elements.
2.1.1 File Header
The file header is simply the first line of text in the XML file. It is static text and does not
change. This first line of text contains the XML declaration—that is, the version of XML is being
used, as well as what encoding method is being used. The following is an example of a File
Header:
<?xml version="1.0" encoding="UTF-8"?>
2.1.2 Root Element
The Root Element consists of static text and does not change. A Root Element is required for
every XML file, and it serves as “the parent” of all the other elements. For the ADR client-level
data XML file, the Root Element is <CLD:ROOT>, and it appears as follows:
<CLD:ROOT xsi:schemaLocation="urn:adrNamespace AdrClientSchema.xsd"
ADR 4.0 Release
XML Schema Implementation Guide
3
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:CLD="urn:adrNamespace">
In this example, CLD stands for “Client-Level Data.” In addition, the <CLD:ROOT> element
contains extra information—called “attributes”—about the file. Each of the attributes has a
name and value. The definitions of each attribute is contained in Table 1.
Table 1 - XML Attribute Definitions
Attribute Name
Definition
xsi:schemaLocation The location of the XML schema definition file used to validate the client-level
data XML file.
xmlns:xsi The location of the XML schema instance used to determine the base XML
schema standards.
xmlns:CLD
The XML schema namespace used for custom definitions within the XML file.
2.1.3 Body Elements
The body of the ADR client-level data XML file contains all the elements under the Root
Element. In the following sample, the top-level elements under the <CLD:ROOT> element have
been collapsed (i.e., their child elements have been hidden) to keep the code sample short.
<?xml version="1.0" encoding="UTF-8"?>
<CLD:ROOT xsi:schemaLocation="urn:adrNamespace AdrClientSchema.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:CLD="urn:adrNamespace">
<AdrClientReportXmlVersion>
<AdrClientReport>
<AdrClientReportRace>
</AdrClientReportRace>
<AdrClientReportHispanicSubgroup>
</AdrClientReportHispanicSubgroup>
<AdrClientReportAsianSubgroup>
</AdrClientReportAsianSubgroup>
<AdrClientReportNhpiSubgroup>
</AdrClientReportNhpiSubgroup>
<AdrClientReportMedicalInsurance>
</AdrClientReportMedicalInsurance>
<AdrClientReportDisenrollmentReason>
</AdrClientReportDisenrollmentReason>
<AdrClientReportMedication>
<Medication>
</Medication>
</AdrClientReportMedication>
</AdrClientReport>
ADR 4.0 Release
XML Schema Implementation Guide
4
</CLD:ROOT>
The body contains “simple” and “complex” elements. In XML, "simple" elements do not contain
any “child” elements while “complex” elements are elements that contain other “child” elements.
The example below shows the format for a complex element.
<ComplexElement>
<SimpleElement1>A valid value</SimpleElement1>
<SimpleElement2>Another valid value</SimpleElement2>
</ComplexElement>
The <ComplexElement> element is “complex” because it contains other elements, whereas the
<SimpleElement1> and <SimpleElement2> elements are “simple" elements because they do
not contain other elements.
In the ADR client-level data XML file, the complex data elements must appear in a specific order
and contain simple data elements in order to pass the validation check.
Likewise, the simple data elements must appear in a specific order, and the data they contain
must conform to the specific rules defined in this data dictionary document to pass the validation
check.
For more information about the other validation checks that the file must pass, please see
Section 4: ADR Client-Level Data XML File Format.
3 ADR Client-Level XML Data Elements
This section includes definitions for all the data elements (both complex and simple) in the body
of the ADR client-level data XML file. The definitions are presented in tables, and each table
includes one or more of the following metadata:
• Id – Indicates the data element’s unique identifier and is used consistently across all public
ADR documents.
• Variable Name – Indicates the name of the complex element.
• Element Name – Indicates the name of the element in the XML file.
• Parent Element – Indicates the name of the parent element.
• Definition – Gives a description of what the element means and/or for what it is used.
• Required – Indicates whether or not a value must be provided for the element when
submitting the ADR. Some elements are optional and do not need values.
• Occurrence – Indicates how many times the element can occur in the file.
• Allowed Values – Describes the values that can be used, cannot be used, or must be used
for a given element.
• Schema – Depicts the XML format for the element.
Empty or “null” data element tags are not permitted in the XML file. For example, data elements
of the form <tag></tag> or <tag /> are not allowed.
ADR 4.0 Release
XML Schema Implementation Guide
5
3.1 Complex Elements
The complex elements in the ADR client-level data XML file are listed and described in the
following sub-sections. These elements are the containers for all the simple elements defined in
Section 3.2: Simple Elements. Each complex element, except for AdrClientReportXmlVersion
contains a required attribute, CLD_ID, that indicates the relationship between each complex
element. For example, complex elements with a value of “1” for the CLD_ID indicate that this
set of complex elements all belong to the same client.
3.1.1 AdrClientReportXmlVersion
Field
Description
Id
Not applicable
Variable Name
AdrClientReportXmlVersion
Definition Complex data element containing information about which version of the
ADR XML schema is being used and which version of the vendor’s
application is being used to generate the ADR XML file. It includes data
such as the schema version, vendor name, vendor application version,
vendor phone number, etc.
Required
Yes
Occurrence
1 per file
Allowed Values
Not applicable
Schema
<AdrClientReportXmlVersion>...
</AdrClientReportXmlVersion>
3.1.2 AdrClientReport
Field
Description
Id
Not applicable
Variable Name
AdrClientReport
Definition Complex data element containing non-repeating client information, such as
the client’s unique identifier, birth year, etc.
Required
Yes
Occurrence
1 per client
Allowed Values
Not applicable
Schema
<AdrClientReport >...
</AdrClientReport>
3.1.3 AdrClientReportRace
Field
Description
Id
Not applicable
Variable
Name
AdrClientReportRace
Definition
Complex data element containing race Ids. Allows multiple race Ids to be
reported.
Required
Yes
Occurrence
1 per client
ADR 4.0 Release
XML Schema Implementation Guide
6
Field
Description
Allowed Values
Not applicable
Schema
<AdrClientReportRace>...
</AdrClientReportRace>
3.1.4 AdrClientReportMedicalInsurance
Field
Description
Id
Not applicable
Variable Name
AdrClientReportMedicalInsurance
Definition Complex data element containing medical insurance Ids. Allows multiple
medical insurance Ids to be reported.
Required
Yes
Occurrence
1 per client
Allowed Values
Not applicable
Schema
<AdrClientReportMedicalInsurance >...
</AdrClientReportMedicalInsurance>
3.1.5 AdrClientReportDisenrollmentReason
Field
Description
Id
Not applicable
Variable Name
AdrClientReportDisenrollmentReason
Definition Complex data element containing reasons for why disenrollment is being
reported.
Required
Yes, only if DisenrollmentReasonId is true
Occurrence
0 to 1 per client
Allowed Values
Not applicable
Schema
<AdrClientReportDisenrollmentReason >...
</AdrClientReportDisenrollmentReason>
3.1.6 AdrClientReportMedication
Field
Description
Id
Not applicable
Variable Name
AdrClientReportMedication
Definition Complex data element containing medication information, such as
medication Id, start date, cost, etc.
Required
Yes, only if MedicationsDispensedFlag is true
Occurrence
0 to N per client
Allowed Values
Not applicable
Schema
<AdrClientReportMedication >...
</AdrClientReportMedication>
ADR 4.0 Release
XML Schema Implementation Guide
7
3.2 Simple Elements
The simple data elements are categorized under the following seven logical “groupings” or sub-
sections:
• XML Schema Version Elements
• System Variables Elements
• Demographic Elements
• Enrollment and Certification Elements
• Insurance Services Elements
• Drug and Drug Expenditure Elements
• Clinical Elements
The purpose of these sub-sections or groupings is to further organize the elements to make
them easier to find in the dictionary as well as the XML file.
Important: Some of the data elements are not required. If no data for a particular client is
being provided for an element, then remove that element entirely from the client’s record (i.e.,
remove the data element's start tag, end tag, and value.)
3.2.1 XML Schema Version Elements
The following XML Schema Version elements are designed to capture data about which version
of the ADR XML schema is being used.
3.2.1.1 AdrSchemaVersion
Field
Description
Id
XV1
Element Name
AdrSchemaVersion
Parent Element
AdrClientReportXmlVersion
Definition
The currently supported ADR XML schema version.
Allowed Values
2.0.0
Required
Yes
Occurrence
1 per file
Schema
<AdrSchemaVersion>2.0.0</AdrSchemaVersion>
3.2.1.2 Vendor
Field
Description
Id
XV2
Element Name
Vendor
Parent Element
AdrClientReportXmlVersion
Definition
The name of your application that is used to generate the ADR XML file.
Allowed Values Text from 1 to 150 characters excluding special characters, such as <
and >.
Required
Yes
Occurrence
1 per file
ADR 4.0 Release
XML Schema Implementation Guide
8
Field
Description
Schema
<Vendor>Rx-REX</Vendor>
3.2.1.3 VendorVersionNumber
Field
Description
Id
XV3
Element Name
VendorVersionNumber
Parent Element
AdrClientReportXmlVersion
Definition
The version of your application that is used to generate the ADR XML file.
Allowed Values Text from 1 to 150 characters excluding special characters, such as <
and >.
Required
Yes
Occurrence
1 per file
Schema
<VendorVersionNumber>1.0.2.0</VendorVersionNumber>
3.2.1.4 VendorTechnicalContactName
Field
Description
Id
XV4
Element Name
VendorTechnicalContactName
Parent Element
AdrClientReportXmlVersion
Definition The name of the technical contact responsible for maintaining your
application that is used to generate the ADR XML file.
Allowed Values Text from 1 to 150 characters excluding special characters, such as, < and
>.
Required
Yes
Occurrence
1 per file
Schema
<VendorTechnicalContactName>John, Doe</VendorTechnicalContactName>
3.2.1.5 VendorTechnicalContactEmail
Field
Description
Id
XV5
Element Name
VendorTechnicalContactEmail
Parent Element
AdrClientReportXmlVersion
Definition The email address of the technical contact responsible for maintaining your
application that is used to generate the ADR XML file.
Allowed Values The technical contact email address must be a valid email address no
greater than 150 characters in length.
Required
Yes
Occurrence
1 per file
Schema
<VendorTechnicalContactEmail>JohnDoe@Somewhere.com</VendorTechnicalCont
actEmail>
3.2.1.6 VendorTechnicalContactPhone
Field
Description
Id
XV6
ADR 4.0 Release
XML Schema Implementation Guide
9
Field
Description
Element Name
VendorTechnicalContactPhone
Parent Element
AdrClientReportXmlVersion
Definition The telephone number of the technical contact responsible for maintaining
your application that is used to generate the ADR XML file.
Allowed Values Must be a valid telephone number in the format 999,999,9999 [x99999],
where the extension is optional, but there must be a space before the “x”.
Required
Yes
Occurrence
1 per file
Schema
<VendorTechnicalContactPhone>123,456,789</VendorTechnicalContactPhone>
3.2.2 System Variables Elements
The following System Variables XML elements are designed to capture unique identifying
information for each client.
3.2.2.1 ClientUci
Field
Description
Id
2
Element Name
ClientUci
Parent Element
AdrClientReport
Definition The encrypted, unique client identifier generated by the HAB UCI generation
utilities.
Allowed Values A 41-character upper-cased, hexadecimal string plus a single character in
the range A-Z.
Required
Yes
Occurrence
1 per client
Schema
<ClientUci>AEC5C1142DE217CD1FA5CBEDB99ED2E265E8E4F8U</ClientUci>
3.2.3 Client Demographics Elements
The following Clinical Demographics XML elements are designed to capture data about the
socio-demographic characteristics of all clients enrolled in the ADAP, whether or not they
received services.
3.2.3.1 EthnicityId
Field
Description
Id
4
Element Name
EthnicityId
Parent Element
AdrClientReport
Definition
The client’s ethnicity.
Allowed Values
A valid ethnicity identifier from the EthnicityLkup table:
1 = Hispanic
2 = Non-Hispanic
Required
No
ADR 4.0 Release
XML Schema Implementation Guide
10
Field
Description
Occurrence
1 per client
Schema
<EthnicityId>2</EthnicityId>
3.2.3.2 RaceId
Field
Description
Id
5
Element Name
RaceId
Parent Element
AdrClientReportRace
Definition
The client’s race.
Allowed Values
A valid race identifier from the RaceLkup table:
1 = White
2 = Black or African American
3 = Asian
4 = Native Hawaiian/Pacific Islander
5 = American Indian or Alaskan Native
Required
Yes
Occurrence
1 to 5 per client
Schema
<RaceId>1</RaceId>
3.2.3.3 AdrClientReportHispanicSubgroup
Field
Description
Id
68
Element Name
AdrClientReportHispanicSubgroup
Parent Element
AdrClientReport
Definition
Value indicating the client’s Hispanic/Latino breakdown.
Allowed Values
A valid Hispanic Subgroup identifier from the HispanicSubgroupLkup table:
1 = Mexican, Mexican American, or Chicano/a
2 = Puerto Rican
3 = Cuban
4 = Another Hispanic, Latino/a, or Spanish origin
Required
Yes, only if the client’s Ethnicity Id is Hispanic
Occurrence
1 – 4 per client
Schema
<AdrClientReportHispanicSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportHispanicSubgroup>
3.2.3.4 AdrClientReportAsianSubgroup
Field
Description
Id
69
Element Name
AdrClientReportAsianSubgroup
Parent Element
AdrClientReport
Definition
Value indicating the client’s Asian breakdown.
Allowed Values
A valid Asian Subgroup identifier from the AsianSubgroupLkup table:
ADR 4.0 Release
XML Schema Implementation Guide
11
Field
Description
1 = Asian Indian
2 = Chinese
3 = Filipino
4 = Japanese
5 = Korean
6 = Vietnamese
7 = Other Asian
Required
Yes, only if the client’s RaceId is Asian
Occurrence
1 – 7 per client
Schema
<AdrClientReportAsianSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportAsianSubgroup>
3.2.3.5 AdrClientReportNhpiSubgroup
Field
Description
Id
70
Element Name
AdrClientReportNhpiSubgroup
Parent Element
AdrClientReport
Definition
Value indicating the client’s Native Hawaiian or Pacific Islander breakdown.
Allowed Values
A valid NHPI Subgroup identifier from the NhpiSubgroupLkup table:
1 = Native Hawaiian
2 = Guamanian or Chamorro
3 = Samoan
4 = Other Pacific Islander
Required
Yes, only if the client’s RaceId is Native Hawaiian/Pacific Islander
Occurrence
1 – 4 per client
Schema
<AdrClientReportNhpiSubgroup>
<SubgroupId>4</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportNhpiSubgroup>
3.2.3.6 GenderId
Field Description
Id
6
Element Name
GenderId
Parent Element
AdrClientReport
Definition
The client’s gender.
Allowed Values
A valid gender identifier from the GenderLkup table:
1 = Male
2 = Female
3 = Transgender
4 = Unknown
Note: Unknown is identified using 9 when generating the encrypted, unique
client identifier (eUCI).
ADR 4.0 Release
XML Schema Implementation Guide
12
Field
Description
Required
Yes
Occurrence
1 per client
Schema
<GenderId>1</GenderId>
3.2.3.7 TransgenderId
Field Description
Id
7
Element Name
TransgenderId
Parent Element
AdrClientReport
Definition
The client’s transgender status.
Allowed Values
A valid transgender identifier from the TransgenderLkup table:
1 = Male-to-Female
2 = Female-to-Male
3 = Unknown
Required
Yes, only if the client’s gender Id is reported as transgender.
Occurrence
0 or 1 per client
Schema
<TransgenderId>3</TransgenderId>
3.2.3.8 SexAtBirthId
Field Description
Id
71
Element Name
SexAtBirthId
Parent Element
AdrClientReport
Definition
The biological sex assigned to the client at birth.
Allowed Values
A valid sex at birth identifier from the SexAtBirthLkup table:
1 = Male
2 = Female
Required
No
Occurrence
1 per client
Schema
<SexAtBirthId>1</SexAtBirthId>
3.2.3.9 BirthYear
Field Description
Id
9
Element Name
BirthYear
Parent Element
AdrClientReport
Definition
The year in which the client was born.
Allowed Values
Four digit years that cannot be greater than the reporting year.
Required
Yes
Occurrence
1 per client
Schema
<BirthYear>1900</BirthYear>
ADR 4.0 Release
XML Schema Implementation Guide
13
3.2.3.10 HivAidsStatusId
Field
Description
Id
10
Element Name
HivAidsStatusId
Parent Element
AdrClientReport
Definition
Client’s HIV/AIDS status at the end of the reporting period.
Allowed Values
A valid HIV/AIDS status identifier from the HivAidsStatusLkup table:
2 = HIV-Positive, not AIDS
3 = HIV-Positive, AIDS status unknown
4 = CDC-defined AIDS
Required
No
Occurrence
1 per client
Schema
<HivAidsStatusId>4</HivAidsStatusId>
3.2.3.11 PovertyLevelId
Field Description
Id
11
Element Name
PovertyLevelId
Parent Element
AdrClientReport
Definition Client’s annual household income as a percent of the Federal Poverty Level
(FPL) at the end of the reporting period.
Allowed Values
A valid Federal poverty level identifier from the PovertyLevelLkup table:
13 = Below 100% of the FPL
9 = 100-138% of the FPL
10 = 139-200% of the FPL
11 = 201-250% of the FPL
12 = 251-400% of the FPL
7 = 401-500% of the FPL
8 = More than 500% of the FPL
Required
No
Occurrence
1 per client
Schema
<PovertyLevelId>10</PovertyLevelId>
3.2.3.12 HighRiskInsuranceId
Field Description
Id
12
Element Name
HighRiskInsuranceId
Parent Element
AdrClientReport
Definition Value indicating if the client was in a High Risk Insurance Pool at any time
during the reporting period.
Allowed Values
A valid High Risk Insurance identifier from the HighRiskInsuranceLkup table:
1 = No
2 = Yes
3 = Unknown
Required
No
ADR 4.0 Release
XML Schema Implementation Guide
14
Field
Description
Occurrence
1 per client
Schema
<HighRiskInsuranceId>1</HighRiskInsuranceId>
3.2.3.13 MedicalInsuranceId
Field
Description
Id
13
Element Name
MedicalInsuranceId
Parent Element
AdrClientReportMedicalInsurance
Definition Value indicating all sources of the client’s health insurance during the
reporting period.
Allowed Values
A valid medical insurance identifier from the MedicalInsuranceLkup table:
10 = Private – Employer
11 = Private – Individual
8 = Medicare Part A/B
9 = Medicare Part D
12 = Medicaid, CHIP, or other public plan
13 = VA, Tricare, or other military health care
14 = IHS
15 = Other Plan
16 = No Insurance/uninsured
Required
Yes
Occurrence
1 to 8 per client
Schema
<MedicalInsuranceId>11</MedicalInsuranceId>
3.2.4 Enrollment and Certification Elements
The following Enrollment and Certification elements capture client enrollment patterns and
certification processes.
3.2.4.1 NewEnrollmentFlag
Field Description
Id
14
Element Name
NewEnrollmentFlag
Parent Element
AdrClientReport
Definition Value indicating if the client is newly enrolled. Newly enrolled clients in
ADAP for this reporting period meet all the following criteria: applied to
ADAP for the first time ever; and met the financial and medical eligibility
criteria of the ADAP during the period for which you are reporting data.
Examples of clients who should not be included in this number are the
following:
• Clients who have been recertified as eligible.
• Clients who have been re-enrolled after a period of having been
decertified/disenrolled.
•
Clients who have moved out of the state and then returned.
ADR 4.0 Release
XML Schema Implementation Guide
15
Field
Description
• Clients who moved on and off ADAP because of fluctuations in eligibility
for a Medicaid/Medically Needy program, based on whether they met
spend-down requirements.
An existing ADAP client is a client who met the following criteria:
• Enrolled in ADAP in a previous reporting period.
• Continues to be enrolled in the current reporting period, regardless of
whether they used ADAP services in either reporting period.
Note: An individual enrolled in ADAP (new or existing client) may or may not
use services. Use of services is not required to be an enrolled client.
Allowed Values
0 for No or 1 for Yes
Required
No
Occurrence
1 per client
Schema
<NewEnrollmentFlag>0</NewEnrollmentFlag>
3.2.4.2 ApplicationReceivedDate
Field
Description
Id
15
Element Name
ApplicationReceivedDate
Parent Element
AdrClientReport
Definition
The date that the completed application was received by the ADAP.
Allowed Values A valid date on or before the last date of the reporting period in the format
mm,dd,yyyy.
Required
Yes, only if client is reported as newly enrolled
Occurrence
0 for existing clients and 1 for newly enrolled clients
Schema
<ApplicationReceivedDate>10,29,2014</ApplicationReceivedDate>
3.2.4.3 ApplicationApprovalDate
Field Description
Id
16
Element Name
ApplicationApprovalDate
Parent Element
AdrClientReport
Definition The date that the client was approved to begin to receive ADAP services.
This is when the client was first enrolled in the ADAP.
Allowed Values A valid date on or before the last date of the reporting period in the format
mm,dd,yyyy.
Required
Yes, only if client is reported as newly enrolled
Occurrence
0 for existing clients and 1 for newly enrolled clients
Schema
<ApplicationApprovalDate>03,27,2014</ApplicationApprovalDate>
3.2.4.4 RecertificationDate
Field Description
Id
17
ADR 4.0 Release
XML Schema Implementation Guide
16
Field
Description
Element Name
RecertificationDate
Parent Element
AdrClientReportRecertificationDate
Definition
The dates on which the client was determined to be eligible to continue to
receive ADAP services.
Note: All individuals enrolled in ADAP, regardless of whether they received
services, must be recertified every six months. This includes clients on a
waiting list. The minimum activities for recertification include: financial
eligibility determination; ensuring that ADAP is the Payer of Last Resort; and
appropriate documentation (i.e.: financial/insurance – or lack thereof/denial
of coverage).
Allowed Values
Valid dates on or before the last date of the reporting period in the format
mm,dd,yyyy.
Required
No
Occurrence
Up to 2 per client
Schema
<RecertificationDate>10,29,2014</RecertificationDate>
3.2.4.5 EnrollmentStatusId
Field Description
Id
18
Element Name
EnrollmentStatusId
Parent Element
AdrClientReport
Definition
The status of the individual in the ADAP at the end of the reporting period.
Allowed Values
A valid enrollment status identifier from the EnrollmentStatusLkup table:
8 = Enrolled, receiving services
9 = Enrolled, on waiting list
10 = Enrolled services not requested
11 = Disenrolled
Required
No
Occurrence
1 per client
Schema
<EnrollmentStatusId>11</EnrollmentStatusId>
3.2.4.6 DisenrollmentReasonId
Field
Description
Id
19
Element Name
DisenrollmentReasonId
Parent Element
AdrClientReportDisenrollmentReason
Definition The reasons the client was disenrolled or discharged during the reporting
period.
Allowed Values
A valid disenrollment reason identifier from the DisenrollmentReasonLkup
table:
9 = Ineligible due to change in ADAP eligibility
10 = Ineligible for ADAP, no longer meets ADAP eligibility
4 = Did not recertify
5 = Did not fill prescription, as required by program
ADR 4.0 Release
XML Schema Implementation Guide
17
Field
Description
6 = Deceased
7 = Dropped out, no reason given
11 = Other/Unknown
Required
Yes, only if the client’s enrollment status Id is reported as disenrolled
Occurrence
1 to 6 per client, where Other/Unknown is mutually exclusive
Schema
<DisenrollmentReasonId>6</DisenrollmentReasonId>
3.2.5 Insurance Services Elements
The following Insurance Services elements capture data about ADAP-funded insurance
assistance services and expenditures. ADAP-funded insurance assistance includes premiums,
co-payments (i.e., co-pays), and deductibles. Co-pays and deductibles for medications should
be reported through these elements.
3.2.5.1 InsuranceAssistanceReceivedFlag
Field
Description
Id
20
Element Name
InsuranceAssistanceReceivedFlag
Parent Element
AdrClientReport
Definition A value indicating if the client received ADAP-funded insurance assistance
during the reporting period, including Medicare Part D. This includes
premiums, deductibles, and co-payments for which ADAP funds were used.
Allowed Values
0 for No or 1 for Yes.
Required
No
Occurrence
1 per client
Schema
<InsuranceAssistanceReceivedFlag>1</InsuranceAssistanceReceivedFlag>
3.2.5.2 InsuranceAssistanceType
Field Description
Id
67
Element Name
InsuranceAssistanceTypeId
Parent Element
AdrInsuranceAssistanceReceived
Definition The type of insurance service(s) that the client received during the reporting
period.
Allowed Values A valid insurance assistance identifier from the
InsuranceAssistanceTypeLkup table:
1 = Full Premium payment
2 = Partial Premium payment
3 = Co-pay/deductible including Medicare Part D co-Insurance, co-payment,
or donut hole coverage.
Required
Yes, if client indicated that insurance assistance was received
Occurrence
1 to 3 per client
Schema
<InsuranceAssistanceTypeId>1</InsuranceAssistanceTypeId>
ADR 4.0 Release
XML Schema Implementation Guide
18
3.2.5.3 InsurancePremiumAmount
Field
Description
Id
21
Element Name
InsurancePremiumAmount
Parent Element
AdrClientReport
Definition The total amount of insurance premium paid on behalf of the client. This
pertains to any premium paid during the reporting period, including Medicare
Part D, regardless of the time frame that it covers (i.e., if it extends outside
the reporting period).
Allowed Values An integer value between 0 and 100,000. Do not include dollar signs or
commas.
Required Yes, only if the client received insurance assistance during the reporting
period.
Occurrence
1 if client received insurance assistance, otherwise 0
Schema
<InsurancePremiumAmount>100</InsurancePremiumAmount>
3.2.5.4 InsurancePremiumMonthCount
Field
Description
Id
22
Element Name
InsurancePremiumMonthCount
Parent Element
AdrClientReport
Definition The total amount of months of coverage for which insurance premium was
paid. Report all months even if they fall outside the reporting period.
Allowed Values
An integer value between 0 and 12.
Required Yes, only if the client received insurance assistance during the reporting
period.
Occurrence
1 if client received insurance assistance, otherwise 0
Schema
<InsurancePremiumMonthCount>2</InsurancePremiumMonthCount>
3.2.5.5 InsuranceDeductibleAndCopayAmount
Field
Description
Id
23
Element Name
InsuranceDeductibleAndCopayAmount
Parent Element
AdrClientReport
Definition The total amount of insurance deductibles and co-pays paid on behalf of the
client, including Medicare Part D. The amount reported should be based on
the date that the deductible or co-pay was paid.
Allowed Values An integer value between 0 and 100,000. Do not include dollar signs or
commas.
Required Yes, only if the client received insurance assistance during the reporting
period
Occurrence
1 if client received insurance assistance, otherwise 0
Schema
<InsuranceDeductibleAndCopayAmount>0</InsuranceDeductibleAndCopayAmount
>
ADR 4.0 Release
XML Schema Implementation Guide
19
3.2.6 Drug and Drug Expenditure Elements
The following Drug and Drug Expenditure XML elements are designed to capture data about
ADAP-funded medications dispensed to clients and total expenditures for those services.
These elements are only for clients who were dispensed ADAP-funded medications paid in full
by ADAP (i.e., not clients for whom only the co-pay or deductible was paid). This includes
Antiretroviral (ARV), Hepatitis B, Hepatitis C, and A1-O1 medications.
3.2.6.1 MedicationsDispensedFlag
Field
Description
Id
25
Element Name
MedicationsDispensedFlag
Parent Element
AdrClientReport
Definition A value indicating if ADAP-funded medications were dispensed to the client
during the reporting period. ADAP-funded medications include any ARV,
Hepatitis B, Hepatitis C, or A1-OI medication on your ADAP-formulary that
was paid for in full with ADAP funds.
Allowed Values
0 for No or 1 for Yes
Required
No
Occurrence
1 per client
Schema
<MedicationsDispensedFlag>1</MedicationsDispensedFlag>
3.2.6.2 MedicationId
Field Description
Id
26
Element Name
MedicationId
Parent Element
AdrClientReportMedication
Medication
Definition The dispensed medication five-digit drug code dispensed to the client during
the reporting period.
Allowed Values
A valid drug code from the MedicationLkup table in the format d#####.
Required
Yes
Occurrence 1 or more if medications were dispensed to this client during the reporting
period, otherwise 0
Schema
<MedicationId>d03984</MedicationId>
3.2.6.3 MedicationStartDate
Field Description
Id
27
Element Name
MedicationStartDate
Parent Element
AdrClientReportMedication
Medication
Definition The dispense date for the medication dispensed to the client during the
reporting period.
Allowed Values
A valid dispense date during the reporting period for each instance the
ADR 4.0 Release
XML Schema Implementation Guide
20
Field
Description
medication was given to the client in the format mm,dd,yyyy.
Required
Yes, if medications were dispensed to this client during the reporting period,
otherwise No
Occurrence 1 or more if medications were dispensed to this client during the reporting
period, otherwise 0
Schema
<MedicationStartDate>10,15,2012</MedicationStartDate>
3.2.6.4 MedicationDays
Field
Description
Id
28
Element Name
MedicationDays
Parent Element
AdrClientReportMedication
Medication
Definition
The number of days for which the medication was dispensed.
Allowed Values
An integer value between 1 and 360. Values should be from 1 through 30,
and then in increments of 30 (i.e., 1 through 30, 60, 90, …, 360). For any
value less than 30, report the actual number of days, otherwise report the
number of days in 30 day increments.
Required Yes, if medications were dispensed to this client during the reporting period,
otherwise No
Occurrence 1 or more if medications were dispensed to this client during the reporting
period, otherwise 0
Schema
<MedicationDays>30</MedicationDays>
3.2.6.5 MedicationCost
Field Description
Id
29
Element Name
MedicationCost
Parent Element
AdrClientReportMedication
Medication
Definition Indicate the cost of each ADAP-funded medication listed in Item 26 that was
dispensed to the client during the reporting period. Cost should be reported
per medication per date dispensed. Include the amount paid for each
prescription that is dispensed, even if the medication prescription period
extended beyond the reporting period.
Allowed Values An integer amount, rounded to the nearest dollar, between 0 and 100,000.
Do not include dollar signs, commas, or cents.
Required Yes, if medications were dispensed to this client during the reporting period,
otherwise No
Occurrence 1 or more if medications were dispensed to this client during the reporting
period, otherwise 0
Schema
<MedicationCost>221</MedicationCost>
ADR 4.0 Release
XML Schema Implementation Guide
21
3.2.7 Clinical Elements
The following Clinical Elements describe the clinical characteristics of ADAP clients who
received ADAP-funded medications. All clients receiving ADAP-funded medications should
have at least one CD4 test result and one viral load reported during the 12 month reporting
period.
3.2.7.1 LastCd4Date
Field
Description
Id
32
Element Name
LastCd4Date
Parent Element
AdrClientReport
Definition Value indicating the client’s most recent CD4 test date during the reporting
period.
Allowed Values
A valid date during the reporting period in the format mm,dd,yyyy.
Required
Yes, if client prescribed medication during the reporting period
Occurrence
0 to 1 per client
Schema
<LastCd4Date>10,25,2014</LastCd4Date>
3.2.7.2 LastCd4Count
Field
Description
Id
33
Element Name
LastCd4Count
Parent Element
AdrClientReport
Definition Value indicating the client’s most recent CD4 test count during the reporting
period.
Allowed Values A valid integer value between 0 and 100,000,000 (cells/mm3). Do not
include commas.
Required
Yes, if client prescribed medication
Occurrence
0 to 1 per client
Schema
<LastCd4Count>332</LastCd4Count>
3.2.7.3 LastViralLoadDate
Field
Description
Id
34
Element Name
LastViralLoadDate
Parent Element
AdrClientReport
Definition Value indicating the client’s most recent viral load test date during the
reporting period.
Allowed Values
A valid date during the reporting period in the format mm,dd,yyyy.
Required
Yes, if client prescribed medication
Occurrence
0 to 1 per client
Schema
<LastViralLoadDate>04,25,2014</LastViralLoadDate>
ADR 4.0 Release
XML Schema Implementation Guide
22
3.2.7.4 LastViralLoadCount
Field
Description
Id
35
Element Name
LastViralLoadCount
Parent Element
AdrClientReport
Definition Value indicating the client’s most recent viral load during the reporting
period.
Allowed Values
A valid integer value between 0 and 100,000,000 (copies/mL). Do not
include commas.
For clients who are undetectable, report the lower test limit for the viral load
count, if available, otherwise report 0.
Required
Yes, if client prescribed medication during the reporting period
Occurrence
0 to 1 per client
Schema
<LastViralLoadCount>47</LastViralLoadCount>
4 ADR Client-Level Data XML File Format
The ADR client-level data XML file structure and content is defined through a set of XML
Schema Definition (XSD) files. The XSD files are used to validate the ADR client-level data
XML files before they can be loaded into the ADR web application. Once loaded, further checks
are performed by the ADR web application.
4.1 Validation Checks to Pass before File Is Accepted by ADR Web
Application
The following validation checks must be satisfied before an ADR client-level data XML file will
be accepted by the ADR web application:
• The XML file must have the .xml extension.
• The XML file must conform to the XML Schema Definition files.
• One and only one set of records per client is allowed in a single XML file.
• An encrypted unique client identifier (ClientUci) may not be repeated within the same
XML file.
• A client is uniquely identified by their encrypted, Unique Client Identifier (eUCI). This
value is represented in the ADR client-level data XML file by the ClientUci data element
within the AdrClientReport complex element. The ClientUci value is an upper-cased, 40
character, hexadecimal value (0-9, A-F) followed by a single suffix from A through Z,
which is used to further identify clients that may share the same base, 40 character
encrypted UCI. The CLD_ID XML attribute is used to link the parent client record with its
child records. The CLD_ID can be any integer value from 1 through 100000, but must
be the same value for a single client.
• The XML complex data elements must appear in the specified order within the file. See
Section 4.2: Sample XML File Format – Collapsed for an example of the sequencing
required.
ADR 4.0 Release
XML Schema Implementation Guide
23
• The XML simple data elements must appear in the specified order within each complex data
element. See Section 4.3: Sample XML File Format - Expanded for an example of the
sequencing required.
• The XML simple data elements must conform to the definitions appearing in this document.
Required fields must be reported and values must be valid and match the documented
format, if defined.
• Empty or “null” data element tags are not permitted in the XML file (i.e., Data elements of the
form <tag></tag> or <tag /> are not allowed.)
Important: Some of the data elements are not required. If no data for a particular client is
being provided for an element, then remove that element entirely from the client’s record (i.e.,
remove the data element's start tag, end tag, and value.)
4.2 Sample XML File Format – Collapsed
The following sample XML displays the complex data elements collapsed to show the required
sequence of the complex elements.
Note: The CLD_ID attribute name below indicates a unique Id for each client report and
associated data such as race and medical insurance.
<?xml version="1.0" encoding="UTF-8"?>
<CLD:ROOT xmlns:CLD="urn:adrNamespace" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
<AdrClientReportXmlVersion>…</AdrClientReportXmlVersion>
<AdrClientReport>
<LastViralLoadCount>
…</LastViralLoadCount>
<AdrClientReportRace>
…</AdrClientReportRace>
<AdrClientReportHispanicSubgroup>
…</AdrClientReportHispanicSubgroup>
<AdrClientReportAsianSubgroup>
…</AdrClientReportAsianSubgroup>
<AdrClientReportNhpiSubgroup>
…</AdrClientReportNhpiSubgroup>
<AdrClientReportMedicalInsurance>
…</AdrClientReportMedicalInsurance>
<AdrClientReportRecertificationDate>
…</AdrClientReportRecertificationDate>
<AdrClientReportDisenrollmentReason>
…</AdrClientReportDisenrollmentReason>
<AdrClientReportMedication>
<Medication>
…</Medication>
</AdrClientReportMedication>
<AdrInsuranceAssistanceReceived>
…</AdrInsuranceAssistanceReceived>
</AdrClientReport>
ADR 4.0 Release
XML Schema Implementation Guide
24
</CLD:ROOT>
4.3 Sample XML File Format – Expanded
The following example shows a sample XML file with the complex data elements expanded in
order to show the required sequence of the simple elements that are organized within them.
Please note that this data are solely used as an example and represent the structure, sequence,
values, and format of the data elements.
<CLD:ROOT xmlns:CLD="urn:adrNamespace" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
<AdrClientReportXmlVersion>
<AdrSchemaVersion>2.0.0</AdrSchemaVersion>
<Vendor>Rx-REX</Vendor>
<VendorVersionNumber>1.0.2.0</VendorVersionNumber>
<VendorTechnicalContactName>John, Doe</VendorTechnicalContactName>
<VendorTechnicalContactEmail>JohnDoe@Somewhere.com</VendorTechnicalContactEmail>
<VendorTechnicalContactPhone>123,456,7890</VendorTechnicalContactPhone>
</AdrClientReportXmlVersion>
<AdrClientReport>
<ClientUci>AEC5C1142DE217CD1FA5CBEDB99ED2E265E8E4F8U</ClientUci>
<EthnicityId>1</EthnicityId>
<GenderId>1</GenderId>
<TransgenderId>3</TransgenderId>
<BirthYear>1900</BirthYear>
<HivAidsStatusId>4</HivAidsStatusId>
<PovertyLevelId>10</PovertyLevelId>
<NewEnrollmentFlag>0</NewEnrollmentFlag>
<ApplicationReceivedDate>03,29,2014</ApplicationReceivedDate>
<ApplicationApprovalDate>04,27,2014</ApplicationApprovalDate>
<EnrollmentStatusId>11</EnrollmentStatusId>
<InsuranceAssistanceReceivedFlag>1</InsuranceAssistanceReceivedFlag>
<InsurancePremiumAmount>0</InsurancePremiumAmount>
<InsurancePremiumMonthCount>2</InsurancePremiumMonthCount>
<InsuranceDeductibleAndCopayAmount>0</InsuranceDeductibleAndCopayAmount>
<MedicationsDispensedFlag>1</MedicationsDispensedFlag>
<LastCd4Date>10,25,2014</LastCd4Date>
<LastCd4Count>332</LastCd4Count>
<LastViralLoadDate>04,25,2014</LastViralLoadDate>
<LastViralLoadCount>47</LastViralLoadCount>
<SexAtBirthId>1</SexAtBirthId>
<AdrClientReportRace>
<RaceId>1</RaceId>
<RaceId>3</RaceId>
</AdrClientReportRace>
<AdrClientReportHispanicSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportHispanicSubgroup>
<AdrClientReportAsianSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportAsianSubgroup>
<AdrClientReportNhpiSubgroup>
<SubgroupId>4</SubgroupId>
<SubgroupId>1</SubgroupId>
ADR 4.0 Release
XML Schema Implementation Guide
25
</AdrClientReportNhpiSubgroup>
<AdrClientReportMedicalInsurance>
<MedicalInsuranceId>11</MedicalInsuranceId>
<MedicalInsuranceId>13</MedicalInsuranceId>
</AdrClientReportMedicalInsurance>
<AdrClientReportRecertificationDate>
<RecertificationDate>10,29,2014</RecertificationDate>
<RecertificationDate>10,15,2014</RecertificationDate>
</AdrClientReportRecertificationDate>
<AdrClientReportDisenrollmentReason>
<DisenrollmentReasonId>6</DisenrollmentReasonId>
<DisenrollmentReasonId>4</DisenrollmentReasonId>
</AdrClientReportDisenrollmentReason>
<AdrClientReportMedication>
<Medication>
<MedicationId>d03984</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>221</MedicationCost>
</Medication>
<Medication>
<MedicationId>d05352</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>994</MedicationCost>
</Medication>
<Medication>
<MedicationId>d05353</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>999</MedicationCost>
</Medication>
</AdrClientReportMedication>
<AdrInsuranceAssistanceReceived>
<InsuranceAssistanceTypeId>1</InsuranceAssistanceTypeId>
<InsuranceAssistanceTypeId>2</InsuranceAssistanceTypeId>
<InsuranceAssistanceTypeId>3</InsuranceAssistanceTypeId>
</AdrInsuranceAssistanceReceived>
</AdrClientReport>
<AdrClientReport>
<ClientUci>AEC5C1142DE217CD1FA5CBEDB99ED2E265E8E4F8X</ClientUci>
<EthnicityId>1</EthnicityId>
<GenderId>1</GenderId>
<TransgenderId>3</TransgenderId>
<BirthYear>1900</BirthYear>
<HivAidsStatusId>4</HivAidsStatusId>
<PovertyLevelId>11</PovertyLevelId>
<NewEnrollmentFlag>0</NewEnrollmentFlag>
<ApplicationReceivedDate>10,29,2014</ApplicationReceivedDate>
<ApplicationApprovalDate>03,27,2014</ApplicationApprovalDate>
<EnrollmentStatusId>11</EnrollmentStatusId>
<InsuranceAssistanceReceivedFlag>1</InsuranceAssistanceReceivedFlag>
<InsurancePremiumAmount>0</InsurancePremiumAmount>
<InsurancePremiumMonthCount>2</InsurancePremiumMonthCount>
<InsuranceDeductibleAndCopayAmount>0</InsuranceDeductibleAndCopayAmount>
<MedicationsDispensedFlag>1</MedicationsDispensedFlag>
<LastCd4Date>10,25,2014</LastCd4Date>
<LastCd4Count>332</LastCd4Count>
ADR 4.0 Release
XML Schema Implementation Guide
26
<LastViralLoadDate>04,25,2014</LastViralLoadDate>
<LastViralLoadCount>47</LastViralLoadCount>
<SexAtBirthId>1</SexAtBirthId>
<AdrClientReportRace>
<RaceId>1</RaceId>
<RaceId>4</RaceId>
<RaceId>6</RaceId>
</AdrClientReportRace>
<AdrClientReportHispanicSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportHispanicSubgroup>
<AdrClientReportAsianSubgroup>
<SubgroupId>3</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportAsianSubgroup>
<AdrClientReportNhpiSubgroup>
<SubgroupId>4</SubgroupId>
<SubgroupId>1</SubgroupId>
</AdrClientReportNhpiSubgroup>
<AdrClientReportMedicalInsurance>
<MedicalInsuranceId>8</MedicalInsuranceId>
<MedicalInsuranceId>9</MedicalInsuranceId>
</AdrClientReportMedicalInsurance>
<AdrClientReportRecertificationDate>
<RecertificationDate>10,29,2014</RecertificationDate>
<RecertificationDate>10,15,2014</RecertificationDate>
</AdrClientReportRecertificationDate>
<AdrClientReportDisenrollmentReason>
<DisenrollmentReasonId>7</DisenrollmentReasonId>
<DisenrollmentReasonId>4</DisenrollmentReasonId>
</AdrClientReportDisenrollmentReason>
<AdrClientReportMedication>
<Medication>
<MedicationId>d03984</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>221</MedicationCost>
</Medication>
<Medication>
<MedicationId>d05352</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>994</MedicationCost>
</Medication>
<Medication>
<MedicationId>d05825</MedicationId>
<MedicationStartDate>10,15,2014</MedicationStartDate>
<MedicationDays>30</MedicationDays>
<MedicationCost>879</MedicationCost>
</Medication>
</AdrClientReportMedication>
<AdrInsuranceAssistanceReceived>
<InsuranceAssistanceTypeId>1</InsuranceAssistanceTypeId>
<InsuranceAssistanceTypeId>2</InsuranceAssistanceTypeId>
<InsuranceAssistanceTypeId>3</InsuranceAssistanceTypeId>
</AdrInsuranceAssistanceReceived>
</AdrClientReport>
ADR 4.0 Release
XML Schema Implementation Guide
27
</CLD:ROOT>
ADR 4.0 Release
XML Schema Implementation Guide
28
Appendix A: Resources
A.1 ADR Client XML Schema Definition Files
The ADR XML schema definitions and sample XML files can be downloaded from ADR
Download Package.
A.2 TRAX (XML Generator)
The Tool for RSR and ADR XML Generation (TRAX) is a HAB tool that can be used to generate
the ADR client-level data XML files. This tool is available on the TARGET Center website.
A.3 TARGET Center Website
The TARGET Center website contains a vast array of technical assistance resources including
the TRAX application, webcasts, training materials, and reference documents, such as the ADR
Instruction Manual.
ADR 4.0 Release
XML Schema Implementation Guide
29
Appendix B: Acronyms
ADAP AIDS Drug Assistance Program
ADR ADAP Data Report
AIDS Acquired ImmunoDeficiency Syndrome
eUCI Encrypted Unique Client Identifier
HAB HIV/AIDS Bureau
HIV Human Immunodeficiency Virus
HRSA Health Resources and Services Administration
UCI Unique Client Identifier
XML Extensible Markup Language
XMLNS XML Namespace
XSD XML Schema Definition
XSI XML Schema Instance
