Reference: Data Elements for the National HIV Surveillance System

Att 3c_NHSS_dataelements OMB_20190313_clean.pdf

National HIV Surveillance System (NHSS)

Reference: Data Elements for the National HIV Surveillance System

OMB: 0920-0573

Document [pdf]
Download: pdf | pdf
Form Approved
OMB No. 0920-0573
Expiration Date: XX/XX/XXXX

National HIV Surveillance System (NHSS)

Attachment 3c.
Data Elements for the National HIV Surveillance System (NHSS)

Form Approved
OMB No. 0920-0573
Expiration Date XX/XX/20XX
Data Elements for the National HIV Surveillance System (NHSS)
Data Elements for Adult HIV l Case Reports
Public reporting burden of this collection of information is estimated to average 20 minutes per response, including the time for reviewing instructions, searching existing
data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. An agency may not conduct or sponsor, and a
persons is not required to respond to a collection of information unless it displays a currently valid OMB control number. Send comments regarding this burden estimate
or any other aspect of this collection of information, including suggestions for reducing this burden to CDC/ATSDR Information Collection Review Office Reports
Clearance Officer; 1600 Clifton Road NE, MS D-74, Atlanta, Georgia 30333; Attn: PRA (0920-0573)
Data Elements for Pediatric HIV Case Reports
Public reporting burden of this collection of information is estimated to average 20 minutes per response, including the time for reviewing instructions, searching existing
data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. An agency may not conduct or sponsor, and a
persons is not required to respond to a collection of information unless it displays a currently valid OMB control number. Send comments regarding this burden estimate
or any other aspect of this collection of information, including suggestions for reducing this burden to CDC/ATSDR Information Collection Review Office Reports
Clearance Officer; 1600 Clifton Road NE, MS D-74, Atlanta, Georgia 30333; Attn: PRA (0920-0573)
Data Elements for Perinatal Exposure Reporting (PHER)
Public reporting burden of this collection of information is estimated to average 30 minutes per response, including the time for reviewing instructions, searching existing data
sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. An agency may not conduct or sponsor, and a persons is not
required to respond to a collection of information unless it displays a currently valid OMB control number. Send comments regarding this burden estimate or any other aspect of
this collection of information, including suggestions for reducing this burden to CDC/ATSDR Information Collection Review Office Reports Clearance Officer; 1600 Clifton Road NE,
MS D-74, Atlanta, Georgia 30333; Attn: PRA (0920-0573)
Data Elements for Investigation Reporting and Evaluation
Public reporting burden of this collection of information is estimated to average 1 minutes per response, including the time for reviewing instructions, searching existing
data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. An agency may not conduct or sponsor, and a
persons is not required to respond to a collection of information unless it displays a currently valid OMB control number. Send comments regarding this burden estimate
or any other aspect of this collection of information, including suggestions for reducing this burden to CDC/ATSDR Information Collection Review Office Reports
Clearance Officer; 1600 Clifton Road NE, MS D-74, Atlanta, Georgia 30333; Attn: PRA (0920-0573)

3-2

March 13, 2019

The data elements listed below include data elements for adult/adolescent case reports (ACRF), pediatric case reports (PCRF), perinatal HIV exposure reporting (PHER), HIV
incidence surveillance information (no longer collected), laboratory test data, investigation reporting and evaluation information and supplemental data collected from other
document types such as birth certificates (BC), and death certificates (DEATH_DOC). Data are stored in tables in the enhanced HIV Reporting System (eHARS). Information in
the table below reflects information in the version of eHARS currently in place, v4.10.5, along with proposed changes to be implemented in eHARS v4.11 in 2020. The column
“Transfer to CDC” indicates whether or not the data collected in a variable are transmitted to CDC. The column “Required/Optional” indicates whether a variable is: (1) a
program requirement for collection (Required); (2) optional for program collection (Optional) , which may include variables that are CDC recommended for collection but
collection is optional; (3) generated by the eHARS system from entered values of other variables and is optional to collect (Optional-System); (4) generated by the eHARS
system (System); (5) retired from collection in eHARS (Retired); (6) retained from the previous case surveillance system and is not collected in eHARS (Legacy HARS); or (7)
retained from the previous incidence surveillance system and is not collected in eHARS (Legacy Incidence). Additional information for users can be found in the eHARS 4.10.5
Technical Reference Guide for variables in the current version of eHARS; additional information about proposed changes to be implemented in eHARS v4.11 can be found in
the Summary of Proposed Changes document.
TABLE NAME
VARIABLES

ADDRESS
address_dt
address_seq
address_type_cd

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

A table that maintains information on a person's addresses and locations.
The most recent date for which this
YYYYMMDD
YES
address is active.
Used by the system as a sequence
YES
identifier for a person's addresses.
A code indicating the type of address, such BAD - Bad address
YES
as RES (residential) or RSA (residence at
COR - Correctional facility
AIDS diagnosis).
CUR - Current
FOS - Foster home
HML - Homeless
POS - Postal
RAD - Residence at death
RBI - Residence at birth
RES - Residential
RHE - Residence at
perinatal exposure
RSR - Residence at pediatric
seroreversion
RSA - Residence at
diagnosis of stage 3 HIV
infection (AIDS)
RSH - Residence at

Document Source

Required/Optional

ACRF, PCRF

Required

All

System

All

Required

TABLE NAME
VARIABLES

DESCRIPTION

addr_type_orig_cd

Additional field for address type
information when the address_type_cd
captures an address event type.

census_block_group

An optional field indicating the census
block group for the person's address.
An optional field indicating the
congressional district for the person's
address.
An optional field indicating the census
group for the person's address.
An optional field indicating the census
metropolitan statistical area (MSA) for the
person's address.
An optional field indicating the census
tract for the person's address.
The city FIPS code for a person's address.
(5 digits)
The textual city name for the person's
address from the FIPS table. If there is no
match to the FIPS table, the text is stored
as entered by the user and preceded by an
asterisk.
The ISO country code for a person's
address.
The FIPS U.S. dependency country code
for the person's address.

census_congressional_d
istrict
census_group
census_msa
census_tract
city_fips
city_name

country_cd
country_usd
3-4

March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
diagnosis of HIV
infectionSHL - Shelter
TMP – Temporary
To be determined – Military
To be determined - Other
BAD - Bad address
COR - Correctional facility
FOS - Foster home
HML - Homeless
POS - Postal
RES - Residential
SHL - Shelter
TMP - Temporary
To be determined - Military
To be determined - Other

Transfer
to CDC

Document Source

Required/Optional

YES

All

Required

NO

ACRF, PCRF

Optional

NO

ACRF, PCRF

Optional

NO

ACRF, PCRF

Optional

NO

ACRF, PCRF

Optional

NO

ACRF, PCRF

Optional

FIPS_CITY (table) - 99999

YES

All

Required

FIPS_CITY (table), ZIP_CITY
(table)

YES

All

Required

COUNTRY_CODE (table)

YES

All

Required

COUNTRY_CODE (table)

YES

All

Required

TABLE NAME
VARIABLES

county_fips
county_name

doc_belongs_to
document_uid
geographic_level

phone
state_cd
street_address1
street_address2
zip_cd
ARV_PROPHYLAXIS
document_uid

drug_seq

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

The FIPS county code for a person's
address.
The county name for the person's address
from the FIPS table. If there is no match to
the FIPS table, the text is stored as
entered by the user and preceded by an
asterisk.
Indicates who the address data belong to:
PERSON, MOTHER, or CHILD.
A unique identifier for a document.
Geographic level to which the address was
geocoded.

FIPS_COUNTY (table) - 999

YES

All

Required

FIPS_COUNTY (table),
ZIP_CITY (table)

YES

All

Required

PERSON, MOTHER, CHILD

YES

All

System

YES
YES

All
All

System
Required

The value indicating a person's telephone
NO
number.
The state postal code for a person's
STATE_CODES
YES
address.
Primary description of a person’s street
NO
address, such as number and street name.
Secondary description of a person’s street
NO
address, such as apartment, building, or
unit and number.
The zip code associated with a person's
ZIP_CITY (table) - 99999
NO
address.
Maintains information on a person's antiretroviral drug and prophylaxis use.

All

Required

All

Required

All

Required

All

Required

All

Required

Identifies the document associated with
each record stored on the table;
document_uid is a unique value generated
by eHARS to identify a document.
Used by the system as a sequence
identifier for each antiretroviral drug
added to a document.

YES

ACRF

System

YES

ACRF

System

1=Census tract
2=Zip code
3=County
4=Insufficient
9999999999

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

obs_uid

An internal identifier for an observation.

drug_cd

Identifier for an antiretroviral drug.

drug_rsn

Reason the person took the antiretroviral
drug.

other_drug_rsn

Text entered to specify the reason the
persons took the antiretroviral drug when
a selection value is not available or
appropriate.
The date the person began taking the
antiretroviral drug.

drug_start_dt

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES

ACRF

System

DRUG

YES

ACRF

Optional

DRUG_RSN_CD

YES

ACRF

Required

YES

ACRF

Required, if
drug_rsn=”OTH”

YYYYMMDD

YES

ACRF

Required

YYYYMMDD

YES

ACRF

Required

drug_last_use_dt

The date the person last used the
antiretroviral drug.

BIRTH_HISTORY

A table that maintains information pertaining to the child's birth or the mother's prenatal care, labor, and delivery. This information is
collected in the Birth History section of Pediatric Case Report Forms (PCRF) and Birth Certificate (BC) documents.

birth_defects

From PCRF, indicates the presence of birth
defects.

YES_NO_UNK

YES

PCRF,
LEGACY_PEDIATRIC

Optional

birth_defects_cd

From PCRF and BC, birth defect codes.

01 - Anencephaly
02 Meningomyelocele/Spina
bifida
03 - Cyanotic congenital
heart disease
04 - Congenital
diaphragmatic hernia
05 - Omphalocele
06 - Gastroschisis
07 - Limb reduction defect
(excluding congenital
amputation and dwarfing
syndromes)
08 - Cleft lip with or
without cleft palate
09 - Cleft palate alone
10 - Down syndrome

YES

PCRF,
LEGACY_PEDIATRIC,
BC

Optional

3-6

March 13, 2019

TABLE NAME
VARIABLES

birth_place
birth_type

DESCRIPTION

From BC, place of birth, such as home or
hospital
From PCRF and BC, the type of birth, such
as single or twin.

birth_wt

From PCRF and BC, the child's birth weight
in grams.

breastfed

From PCRF and BC: Was this child
breastfed?
From PCRF and BC, the method of
delivery, such as vaginal or Cesarean.

delivery_method

document_uid
first_pnc_visit_dt
infant_transfer

A unique identifier for the PCRF or BC.
From BC, the date of the mother's first
prenatal care visit.
From BC: Was the infant transferred to
another facility?

Valid data element values
(lookup type, reference
table, or actual values)
11 - Suspected
chromosomal disorder
12 - Down syndrome
(karyotype confirmed)
13 - Suspected
chromosomal disorder
(karyotype confirmed)
14 - Down syndrome
(karyotype pending)
15 - Suspected
chromosomal disorder
(karyotype pending)
16 - Hypospadias
17 - None of the anomalies
listed above
BIRTH_PLACE

Transfer
to CDC

Document Source

Required/Optional

YES

BC

Optional

1 - Single
2 - Twin
3 - >2
9 - Unknown
NULL, MIN = 28, MAX =
9070

YES

PCRF,
LEGACY_PEDIATRIC,
BC

Optional

YES

PCRF,
LEGACY_PEDIATRIC,
BC

Optional

YES_NO_UNK

YES

BC

Optional

DELIVERY, DELIVERY_BC

YES

PCRF,
LEGACY_PEDIATRIC,
BC

Optional

YYYYMMDD

YES
YES

All
BC

System
Optional

YES_NO

YES

BC

Optional

TABLE NAME
VARIABLES

last_live_birth_dt

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

From BC, the date of the mother's last live
birth.
From BC, the date of the mother's last
menses.
From BC, the date of the mother's last
prenatal care visit.
From PCRF, the mother's country of birth.

YYYYMMDD

YES

BC

Optional

YYYYMMDD

YES

BC

Optional

YYYYMMDD

YES

BC

Optional

COUNTRY_CODE (table)

YES

PCRF,
LEGACY_PEDIATRIC

Optional

maternal_birth_country
_usd

From PCRF, the mother's country of birth
if U.S. dependency.

COUNTRY_CODE (table)

YES

PCRF,
LEGACY_PEDIATRIC

Optional

maternal_dob

From PCRF, the mother's date of birth.

YYYYMMDD

YES

PCRF,
LEGACY_PEDIATRIC

Optional

maternal_sndx

From PCRF, the mother's last name
Soundex.

YES

PCRF,
LEGACY_PEDIATRIC

Optional

maternal_stateno

From PCRF, the mother's STATENO
identifier.

YES

PCRF,
LEGACY_PEDIATRIC

Optional

month_preg_pnc

From PCRF, the month of pregnancy that
mother's prenatal care began.

01 - 12, 99(unknown),
00(none)

YES

PCRF,
LEGACY_PEDIATRIC

Optional

neonatal_status

From PCRF, the child's neonatal status.

YES

From PCRF and BC, the gestational age of
the child at delivery.

PCRF,
LEGACY_PEDIATRIC,
BC
PCRF,
LEGACY_PEDIATRIC,
BC

Optional

neonatal_status_weeks

1 - Full Term
2 - Premature
9 - Unknown
01 - 98, 99(unknown),
00(none)

num_pnc_visits

From PCRF and BC, the number of
prenatal care visits.

01-98, 99(unknown),
00(none)

YES

PCRF,
LEGACY_PEDIATRIC,
BC

Optional

num_prev_live_births

From BC, the number of previous live
00-99
YES
births.
A table that maintains information on a person's calculated observations.

BC

Optional

A unique identifier for a calculated
observation.

All

Refer to
CALC_OBSERVATION_C
ODE table for
requirements for each
variable

last_normal_menses_dt
last_pnc_visit_dt
maternal_birth_country
_cd

CALC_OBSERVATION
calc_obs_uid

3-8

March 13, 2019

CALC_OBSERVATION_CODE
(table)

YES

YES

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

The calculated observation's value.

document_uid
CALC_OBSERVATION_C
ODE
1

A unique identifier for a document.
YES
A table that maintains information calc_obs_value and associated descriptions.

All

Refer to
CALC_OBSERVATION_C
ODE table for valid data
element values for each
variable
System

HARS Legacy - AIDS category

2

HARS Legacy - HIV category

3

HARS Legacy - Date the first disease was
diagnosed based on the 1993 expanded
AIDS case definition
HARS Legacy - Date the first disease was
diagnosed based on the pre-1993
expanded AIDS case definition
HARS Legacy - Date of the first condition
classifying as AIDS based on the current
AIDS case definition

5

All

Required/Optional

calc_obs_value

4

YES

Document Source

1 - Definitive (pre-85) case
2 - Definitive (1985) case
3 - Definitive (1987) case
4 - Presumptive (1987) case
5 - Definitive (1993) case
6 - Presumptive (1993) case
7 - Immunologic (1993)
case
8 - Undetermined case
9 - Non-case
1 - HIV Definitive
2 - HIV Presumptive
3 - HIV Indeterminate
4 - HIV Negative Definitive
5 - HIV Negative
Presumptive
8 - Pending Confirmation
9 - HIV Unknown
YES_NO

YES

All

System

YES

All

System

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

TABLE NAME
VARIABLES

6
7
8
9
10
11
12
13
14
15
16
17
18
19

3-10

DESCRIPTION

HARS Legacy - Date of the first condition
classifying as AIDS based on the applicable
AIDS case definition
HARS Legacy - Date of last negative HIV
test result
HARS Legacy - Date a case was reported as
HIV positive
HARS Legacy - Date a case was reported as
AIDS category level 1
HARS Legacy - Date a case was reported as
AIDS category level 2
HARS Legacy - Date a case was reported as
AIDS category level 3
HARS Legacy - Date a case was reported as
AIDS category level 4
HARS Legacy - Date a case was reported as
AIDS category level 5
HARS Legacy - Date a case was reported as
AIDS category level 6
HARS Legacy - Date a case was reported as
AIDS category level 7
HARS Legacy - Date a case was reported as
not infected with HIV
HARS Legacy - Date a case was reported as
perinatal exposure
HARS Legacy - Date the death of a case
was reported
HARS Legacy - Mode of transmission

March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

01 - Male sexual contact
with other male (MSM)
02 - Injection drug use
(nonprescription) (IDU)
03 - Male sexual contact
with other male and
injection drug use (MSM &
IDU)
04 - Adult received clotting
factor for
hemophilia/coagulation

YES

All

System

TABLE NAME
VARIABLES

20

DESCRIPTION

HARS Legacy - Class

Valid data element values
(lookup type, reference
table, or actual values)
disorder
05 - Heterosexual contact
06 - Adult received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial
insemination
08 - Adult with other
confirmed risk
09 - Adult with risk not
reported/other
11 - Child received clotting
factor for
hemophilia/coagulation
disorder
12 - Mother with, or at risk
for, HIV infection
13 - Child received
transfusion of blood/blood
components or transplant
of organ/tissue
14 - Child with other risk
18 - Child with other
confirmed risk
19 - Child with risk not
reported/other
A1 - Asymptomatic, CD4
count > 500 or percent >
29%
A2 - Asymptomatic, CD4
count 200-499 or percent
14-28%
A3 - Asymptomatic, CD4
count < 200 or percent <
14%

Transfer
to CDC

YES

Document Source

All

Required/Optional

System

TABLE NAME
VARIABLES

21
78
85
86
3-12

DESCRIPTION

HARS Legacy - Date of first positive HIV
test result or doctor diagnosis of HIV
HARS Legacy - CD4 count < 400
HARS Legacy - First positive HIV-1 EIA test
result date
HARS Legacy - Last negative HIV-1 EIA test
result date
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

A9 - Asymptomatic,
unknown CD4
B1 - Symptomatic, CD4
count > 500 or percent >
29%
B2 - Symptomatic, CD4
count 200-499 or percent
14-28%
B3 - Symptomatic, CD4
count < 200 or percent <
14%
B9 - Symptomatic,
unknown CD4
C1 - AIDS, CD4 count > 500
or percent > 29%
C2 - AIDS, CD4 count 200499 or percent 14-28%
C3 - AIDS, CD4 count < 200
or percent < 14%
C9 - AIDS, unknown CD4
Unknown clinical category,
X1 - CD4 count > 500 or
percent > 29%
X2 - Unknown clinical
category, CD4 count 200499 or percent 14-28%
X3 - Unknown clinical
category, CD4 count < 200
or percent < 14%
X9 - Unknown clinical
category, unknown CD4
YYYYMMDD

YES

All

System

YES_NO
YYYYMMDD

YES
YES

All
All

System
System

YYYYMMDD

YES

All

System

TABLE NAME
VARIABLES

87
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

DESCRIPTION

HARS Legacy - Most recent HIV-1 EIA test
result value
HARS Legacy - Most recent HIV-1 EIA test
result date
HARS Legacy - Overall HIV-1 EIA test result
value
HARS Legacy - Overall HIV-1 EIA test result
date
HARS Legacy - First positive HIV-1/2
combined test result date
HARS Legacy - Last negative HIV-1/2
combined test result date
HARS Legacy - Most recent HIV-1/2
combined test result value
HARS Legacy - Most recent HIV-1/2
combined test result date
HARS Legacy - Overall HIV-1/2 combined
test result value
HARS Legacy - Overall HIV-1/2 combined
test result date
HARS Legacy - First positive Western
Blot/IFA test result date
HARS Legacy - Last negative Western
Blot/IFA test result date
HARS Legacy - Most recent Western
Blot/IFA test result value
HARS Legacy - Most recent Western
Blot/IFA test result date
HARS Legacy - Overall Western Blot/IFA
test result value
HARS Legacy - Overall Western Blot/IFA
test result date
HARS Legacy - First positive Other HIV
Antibody test result date

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

POS=Positive
NEG=Negative

YES

All

System

YES

All

System

POS=Positive
NEG=Negative
YYYYMMDD

YES

All

System

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

POS=Positive
NEG=Negative
YYYYMMDD

YES

All

System

YES

All

System

POS=Positive
NEG=Negative
YYYYMMDD

YES

All

System

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

TABLE NAME
VARIABLES

105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
3-14

DESCRIPTION

HARS Legacy - Last negative Other HIV
Antibody test result date
HARS Legacy - Most recent Other HIV
Antibody test result value
HARS Legacy - Most recent Other HIV
Antibody test result date
HARS Legacy - Overall Other HIV Antibody
test result value
HARS Legacy - Overall Other HIV Antibody
test result date
HARS Legacy - First positive
Detection/Antigen/Viral load test result
date
HARS Legacy - Last negative
Detection/Antigen/Viral load test result
date
HARS Legacy - Most recent
Detection/Antigen/Viral load test result
value
HARS Legacy - Most recent
Detection/Antigen/Viral load test result
date
HARS Legacy - Overall
Detection/Antigen/Viral load test result
value
HARS Legacy - Overall
Detection/Antigen/Viral load test result
date
HARS Legacy - Most recent CD4 count
value
HARS Legacy - Most recent CD4 percent
value
HARS Legacy - Most recent CD4 test result
date
HARS Legacy - Lowest count from all CD4
test result values
HARS Legacy - Lowest CD4 count test
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

POS_NEG_IND

YES

All

System

YYYYMMDD

YES

All

System

YES

All

System

YES

All

System

YES

All

System

YES

All

System

YES

All

System

YYYYMMDD

YYYYMMDD

TABLE NAME
VARIABLES

121
122
123
124
125
216

DESCRIPTION

result date
HARS Legacy - Lowest percent from all
CD4 test result values
HARS Legacy - Lowest CD4 percent test
result date
HARS Legacy - First CD4 count < 200 value
HARS Legacy - First CD4 percent < 14 value
HARS Legacy - First CD4 count < 200 or
percent < 14 date
HARS Legacy - Expanded mode of
transmission

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES
YES
YES

All
All
All

System
System
System

YES

All

System

01 - Male sexual contact
with other male (MSM)
02 - Injection drug use
(nonprescription) (IDU)
03 - Male sexual contact
with other male and
injection drug use (MSM &
IDU)
04 - Adult received clotting
factor for
hemophilia/coagulation
disorder
05 - Heterosexual contact
with injection drug user
06 - Heterosexual contact
with bisexual man
07 - Heterosexual contact
with person with
hemophilia
08 - Born in an NIR country
Heterosexual contact with
person born in an NIR
country
09 - Heterosexual contact
with HIV-infected
transfusion recipient

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
11 - Heterosexual contact
with HIV-infected person
12 - Heterosexual contact
with person at risk for HIV
infection
13 - Adult received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial
insemination
14 - Adult with risk not
reported/other
15 - Child received clotting
factor for
hemophilia/coagulation
disorder
16 - Mother injection drug
use (nonprescription) (IDU)
17 - Mother had sex with
male injection drug user
18 - Mother had sex with
bisexual man
19 - Mother had sex with
person with hemophilia
20 - Mother born in an NIR
country
21 - Mother had sex with
person born in an NIR
country
22 - Mother had sex with
HIV-infected transfusion
recipient
23 - Mother had sex with
HIV-infected man
24 - Mother received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial

3-16

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

217

Old race

218

Race

219

Earliest date the first document was
entered into the system
Earliest date the first document was
received at the health department

220

Valid data element values
(lookup type, reference
table, or actual values)
insemination
25 - Mother has HIV
infection
26 - Child received
transfusion of blood/blood
components or transplant
of organ/tissue
27 - Child with risk not
reported/other
28 - Child with other risk
88 - Child with other
confirmed risk
1 - White, not Hispanic
2 - Black, not Hispanic
3 - Hispanic
4 - Asian/Pacific Islander
5 - American Indian/Alaska
Native
9 - Unknown
1 - Hispanic, All races
2 - Not Hispanic, American
Indian/Alaska Native
3 - Not Hispanic, Asian
4 - Not Hispanic, Black
5 - Not Hispanic, Native
Hawaiian/Pacific Islander
6 - Not Hispanic, White
7 - Not Hispanic, Legacy
Asian/Pacific Islander
8 - Not Hispanic, Multi-race
9 - Unknown
YYYYMMDD
YYYYMMDD

Transfer
to CDC

Document Source

Required/Optional

YES

All

System

YES

All

System

YES

All

System

YES

All

System

TABLE NAME
VARIABLES

221

3-18

DESCRIPTION

Transmission category

March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
01 - Male sexual contact
with other male (MSM)
02 - Injection drug use
(nonprescription) (IDU)
03 - Male sexual contact
with other male and
injection drug use
(MSM+IDU)
04 - Adult received clotting
factor for
hemophilia/coagulation
disorder
05 - Heterosexual contact
06 - Adult received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial
insemination
07 - Perinatal exposure
with HIV infection first
diagnosed at age 13 years
or older
08 - Adult with other
confirmed risk
09 - Adult with No
Identified Risk (NIR)
10 - Adult with No
Reported Risk (NRR)
11 - Child received clotting
factor for
hemophilia/coagulation
disorder
12 - Perinatal exposure
13 - Child received
transfusion of blood/blood
components or transplant
of organ/tissue
18 - Child with other

Transfer
to CDC

YES

Document Source

All

Required/Optional

System

TABLE NAME
VARIABLES

222

DESCRIPTION

Expanded transmission category

Valid data element values
(lookup type, reference
table, or actual values)
confirmed risk
19 - Child with No Identified
Risk (NIR)
20 - Child with No Reported
Risk (NRR)
00 - Risk factors selected
with no age at diagnosis
01 - Male sexual contact
with other male (MSM)
02 - Injection drug use
(nonprescription) (IDU)
03 - Male sexual contact
with other male and
injection drug use (MSM &
IDU)
04 - Adult received clotting
factor for
hemophilia/coagulation
disorder
05 - Heterosexual contact
with IDU
06 - Heterosexual contact
with male who had sexual
contact with other male
07 - Heterosexual contact
with person with
hemophilia
10 - Heterosexual contact
with blood
transfusion/transplant
recipient with documented
HIV infection
11 - Heterosexual contact
with person with AIDS or
documented HIV infection,

Transfer
to CDC

YES

Document Source

All

Required/Optional

System

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
risk not specified
13 - Adult received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial
insemination
14 - Adult with
undetermined transmission
category
15 - Child received clotting
factor for
hemophilia/coagulation
disorder
16 - Perinatal exposure,
mother had injection drug
use
17 - Perinatal exposure,
mother had heterosexual
contact with IDU
18 - Perinatal exposure,
mother had heterosexual
contact with bisexual male
19 - Perinatal exposure,
mother had heterosexual
contact with person with
hemophilia
22 - Perinatal exposure,
mother had heterosexual
contact with blood
transfusion/transplant
recipient with documented
HIV infection
23 - Perinatal exposure,
mother had heterosexual
contact with male with
AIDS or documented HIV
infection, risk not specified
24 - Perinatal exposure,

3-20

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

223

DESCRIPTION

Exposure category

Valid data element values
(lookup type, reference
table, or actual values)
mother received
transfusion of blood/blood
components, transplant of
organ/tissue, or artificial
insemination
25 - Perinatal exposure,
mother with documented
HIV infection
26 - Child received
transfusion of blood/blood
components or transplant
of organ/tissue
27 - Child with
undetermined transmission
category
28 - Child with other
confirmed risk
88 - Adult with other
confirmed risk
99 - Risk factors selected
with no age at diagnosis
01 - MSM only
02 - IDU only
03 - Heterosexual contact
only
04 - MSM & IDU
05 - IDU & Heterosexual
contact
06 - MSM & Heterosexual
contact
07 - MSM & IDU &
Heterosexual contact
08 - Perinatal exposure
09 - Other
10 - No Identified Risk (NIR)

Transfer
to CDC

YES

Document Source

All

Required/Optional

System

TABLE NAME
VARIABLES

224
225
226
227
228
229
230
243
244
245
246
247
252
253
254
255
256
257
258
259
260
261
262
3-22

DESCRIPTION

Date of first positive HIV test result or
doctor diagnosis of HIV
Type of first evidence of HIV infection
(positive HIV test result or doctor
diagnosis of HIV)
First CD4 or viral load test result date after
HIV diagnosis
Type of first test after HIV diagnosis (CD4
or viral load)
Most recent test result date
Most recent test type
Most recent test result value
First detectable viral load test result date
First detectable viral load test result value
(copies/ml)
Most recent viral load test result value
(copies/ml)
Most recent viral load test result date
Most recent undetectable viral load test
result date
The earliest date on which the
immunologic criteria for stage 3 were met
First CD4 count test result < 350 value
First CD4 count test result < 350 date
Most recent CD4 count test result value
Most recent CD4 count test result date
Most recent CD4 percent test result value
Most recent CD4 percent test result date
Most recent CD4 test result (count or
percent) date
First CD4 test result value after HIV
diagnosis
First CD4 test result date after HIV
diagnosis
Lowest CD4 count test result value
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
11 - No Reported Risk (NRR)
YYYYMMDD

Transfer
to CDC

Document Source

Required/Optional

YES

All

System

1 - Lab test
2 - Physician diagnosis

YES

All

System

YYYYMMDD

YES

All

System

1 - CD4
2 - Viral load
YYYYMMDD
1 - CD4
2 - Viral load
LAB_RESULT_VALUE
YYYYMMDD

YES

All

System

YES
YES

All
All

System
System

YES
YES
YES

All
All
All

System
System
System

YES

All

System

YYYYMMDD
YYYYMMDD

YES
YES

All
All

System
System

YYYYMMDD

YES

All

System

YES
YES
YES
YES
YES
YES
YES

All
All
All
All
All
All
All

System
System
System
System
System
System
System

YES

All

System

YES

All

System

YES

All

System

YYYYMMDD
YYYYMMDD
YYYYMMDD
YYYYMMDD

YYYYMMDD

TABLE NAME
VARIABLES

263
264
265
266

DESCRIPTION

270
271
272

Lowest CD4 count test result date
Lowest CD4 percent test result value
Lowest CD4 percent test result date
First positive Qualitative RNA/DNA test
result date
Most recent Qualitative RNA/DNA test
result value
Most recent Qualitative RNA/DNA test
result date
Most recent negative Qualitative
RNA/DNA Test Result date
First positive HIV antigen test result date
First positive HIV culture test result date
HIV case definition category

273

AIDS case definition category

274
275
276
277
278
279

Age at HIV diagnosis (years)
Age at HIV diagnosis (months)
Age at AIDS diagnosis (years)
Age at AIDS diagnosis (months)
Age at HIV disease diagnosis (years)
Age at HIV disease diagnosis (months)

267
268
269

Valid data element values
(lookup type, reference
table, or actual values)
YYYYMMDD

Transfer
to CDC

Document Source

Required/Optional

YES
YES
YES
YES

All
All
All
All

System
System
System
System

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD
YYYYMMDD
1 - HIV positive, definitive
2 - HIV positive,
presumptive
3 - HIV indeterminate
4 - HIV negative, definitive
5 - HIV negative,
presumptive
8 - Pending confirmation
9 - Unknown
7 - AIDS case defined by
immunologic (CD4 count or
percent) criteria
9 - Not an AIDS case
A - AIDS case defined by
clinical disease (OI) criteria
1-99
1-99
1-99
1-99
1-99
1-99

YES
YES
YES

All
All
All

System
System
System

YES

All

System

YES
YES
YES
YES
YES
YES

All
All
All
All
All
All

System
System
System
System
System
System

YYYYMMDD
YYYYMMDD

TABLE NAME
VARIABLES

281
282

285
287

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
3-24

DESCRIPTION

Date of the earliest condition classifying
the case as stage 3 HIV infection
The earliest date on which the clinical
disease criterion (opportunistic illness [OI]
diagnosis) for stage 3 HIV infection was
met
HIV disease diagnosis date
Diagnostic status

Date reported as HIV positive
Date reported as not infected with HIV
(seroreverters)
Date reported as perinatal exposure
Date reported as AIDS (non-immunologic)
Date reported as AIDS (immunologic)
Date reported as AIDS (earliest)
Date reported as HIV disease
Disease progression category (report date)
Disease progression category (diagnosis
date)
Meets CDC case definition for HIV (not
AIDS)
Meets CDC case definition for AIDS
Meets CDC case definition for HIV disease
Meets CDC eligibility for HIV (not AIDS)
Meets CDC eligibility for AIDS
Meets CDC eligibility for HIV disease
Age at death (years)
Age at death (months)
Date death reported
Type of first CD4 test after HIV diagnosis
(count or percent)
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD
1 - Adult HIV
2 - Adult AIDS
3 - Perinatal HIV exposure
4 - Pediatric HIV
5 - Pediatric AIDS
6 - Pediatric seroreverter
9 - Unknown
YYYYMMDD
YYYYMMDD

YES
YES

All
All

System
System

YES
YES

All
All

System
System

YYYYMMDD
YYYYMMDD
YYYYMMDD
YYYYMMDD
YYYYMMDD
YYYYMMDD
YYYYMMDD

YES
YES
YES
YES
YES
YES
YES

All
All
All
All
All
All
All

System
System
System
System
System
System
System

YES_NO

YES

All

System

YES_NO
YES_NO
YES_NO
YES_NO
YES_NO
1-99
1-99
YYYYMMDD
RESULT_UNITS_CD4

YES
YES
YES
YES
YES
YES
YES
YES
YES

All
All
All
All
All
All
All
All
All

System
System
System
System
System
System
System
System
System

TABLE NAME
VARIABLES

307

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

Meets CDC case definition for HIV
perinatal exposure or pediatric
seroreverter
Meets CDC eligibility for HIV perinatal
exposure or pediatric seroreverter
Stage 0 HIV infection at diagnosis

YES_NO

YES

All

System

YES_NO

YES

All

System

A – Acute HIV infection(part
of stage 0) at diagnosis
B – Post-acute early HIV
infection (part of stage 0) at
diagnosis
N – Insufficient evidence
for Stage 0 at diagnosis

YES

All

System

313

Stage at diagnosis based only on CD4 and
opportunistic illness (OI)

YES

All

System

314

Date of earliest use of antiretroviral
medications for HIV treatment
Date of last use of antiretroviral
medications for HIV treatment
Date of earliest use of antiretroviral
medications for pre-exposure prophylaxis
Date of last use of antiretroviral
medications for pre-exposure prophylaxis
Date of earliest use of antiretroviral
medications for post-exposure prophylaxis
Date of last use of antiretroviral
medications for post-exposure prophylaxis

1 - Stage 1, CD4 cnt≥500 or
CD4 pct≥26
2 - Stage 2, 200≤CD4
cnt≤499 or 14≤CD4 pct≤25
3 - Stage 3, OI or CD4
cnt<200 or CD4 pct <14
9 - Stage unknown
YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

308
312

315
316
317
318
319

TABLE NAME
VARIABLES

320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

3-26

DESCRIPTION

Date of earliest use of antiretroviral
medications for prevention of mother-tochild transmission
Date of last use of antiretroviral
medications for prevention of mother-tochild transmission
Date of earliest use of antiretroviral
medications for Hepatitis B treatment
Date of last use of antiretroviral
medications for Hepatitis B
Date of earliest use of antiretroviral
medications for other reasons
Date of last use of antiretroviral
medications for other reasons
Date of earliest use of antiretroviral
medications
Date of last use of antiretroviral
medications
Did mother receive any antiretroviral
medications prior to this pregnancy?
Date of mother’s earliest use of
antiretroviral medications prior to this
pregnancy
Date of mother’s last use of antiretroviral
medications prior to this pregnancy
Did mother receive any antiretroviral
medications during pregnancy?
Date of mother’s earliest use of
antiretroviral medications during
pregnancy
Date of mother’s last use of antiretroviral
medications during pregnancy
Did mother receive any antiretroviral
medications during labor/delivery?
Date of mother’s earliest use of
antiretroviral medications during
labor/delivery
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YES, NO_REF_UNK

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YES, NO_REF_UNK

YES

All

System

YYYYMMDD

YES

All

System

YYYYMMDD

YES

All

System

YES, NO_REF_UNK

YES

All

System

YYYYMMDD

YES

All

System

TABLE NAME
VARIABLES

336

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

System

cdate1
cdate2
document_uid
DEATH

Date of mother’s last use of antiretroviral
YYYYMMDD
YES
All
medications during labor/delivery
Ever transgender or additional gender
MF, FM, AD
YES
All
identity
Ever had a negative HIV test
YES_NO_UNK
YES
All
Date of last negative HIV test
YYYYMMDD
YES
All
Date of last negative HIV test among
YYYYMMDD
YES
All
eHARS laboratory test results
A table that maintains information on a person's consent for STARHS.
Note: All variables in this tables were not collected since 2005, but are stored in eHARS.
Did the person consent to participate in
YES_NO_UNK
YES
LEGACY_CONSENT
STARHS when approached the first time?
Did the person consent to participate in
YES_NO_UNK
YES
LEGACY_CONSENT
STARHS when approached the second
time?
The type of visit when the person was
01 - Pre-test
YES
LEGACY_CONSENT
approached for STARHS consent the first
02 - Post-test
time.
03 - Other Follow-up
The type of visit when the person was
01 - Pre-test
YES
LEGACY_CONSENT
approached for STARHS consent the
02 - Post-test
second time.
03 - Other Follow-up
Date of first approach for consent.
YYYYMMDD
YES
LEGACY_CONSENT
Date of second approach for consent.
YYYYMMDD
YES
LEGACY_CONSENT
A unique identifier for a document.
YES
LEGACY_CONSENT
A table that maintains information on a person's death.

autopsy

Was an autopsy performed?

YES_NO_UNK

YES

LEGACY_NDI,
DEATH_DOC

Optional

city_fips

The FIPS code for the city where the
person died.

FIPS_CITY (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

city_name

The name of the city where the person
died.

FIPS_CITY (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

337
To be determined
To be determined
To be determined
CONSENT_QUESTIONN
AIRE
cconsent1
cconsent2
cconsentvisit1
cconsentvisit2

System
System
System
System

Retired
Retired
Retired
Retired
Retired
Retired
System

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

country_cd

The ISO code for the country where the
person died.

COUNTRY_CODE (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

country_usd

The U.S. Dependency code where the
person died.

COUNTRY_CODE (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

county_fips

The FIPS code for the county where the
person died.

FIPS_COUNTY (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

county_name

The name of the county where the person
died.

FIPS_COUNTY (table)

YES

LEGACY_NDI,
DEATH_DOC

Optional

document_uid

A unique identifier for the Death
Document.

YES

ACRF, PCRF,
DEATH_DOC,
LEGACY_NDI,
LEGACY_ADULT,
LEGACY_PEDIATRIC

System

dod

The person's date of death.

YYYYMMDD

YES

ACRF, PCRF,
DEATH_DOC,
LEGACY_NDI,
LEGACY_ADULT,
LEGACY_PEDIATRIC

Required if person’s
vital status = Dead

place

The type of place where the person died,
such as a residence or hospital.

1 - Hospital, inpatient
2 - Hospital, outpatient or
emergency room
3 - Hospital, dead on arrival
4 - Nursing home or
hospice
5 - Residence
6 - Jail/Adult detention
center
7 - Juvenile detention
center
8 - Group/Assisted living
home
9 - Homeless shelter
10 - Homeless, on the
street
11 - Hospital, institution
(HARS)

YES

DEATH_DOC,
LEGACY_NDI,

Optional

3-28

March 13, 2019

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

888 - Other
999 - Unknown

state_cd

The postal code for the state where the
person died.

DEATH_DX
descr

A table that maintains information on a person's causes of death.
A phrase or statement describing the
cause of death.

document_uid

A unique identifier for the Death
Document.

icd_cd

The ICD code assigned.

icd_cd_type
line
line_number
nature_of_injury

position

STATE_CODES

YES

ACRF, PCRF,
DEATH_DOC,
LEGACY_NDI,
LEGACY_ADULT,
LEGACY_PEDIATRIC

Required if person’s
vital status = Dead

YES

LEGACY_NDI,
DEATH_DOC

Optional

YES

LEGACY_NDI,
DEATH_DOC

Optional

ICD9, ICD10

YES

LEGACY_NDI,
DEATH_DOC

Optional

The type of ICD code assigned, either ICD
9 (represented by 9) or ICD 10
(represented by 10).
A system generated number for NCHS
electronic data, the line number on the
tape.
A number indicating the sequence of
death causes (00 is first).

9 - ICD-9
10 - ICD-10

YES

LEGACY_NDI,
DEATH_DOC

Optional

1-9

YES

LEGACY_NDI,
DEATH_DOC

Optional

00-20

YES

LEGACY_NDI,
DEATH_DOC

Optional

For NCHS electronic data, the nature of
injury flag (1 represents nature of injury
codes and 0 represents all other cause
codes).
Corresponds to the position of the cause
of death on each line of the death
certificate (1 if the cause is the first one

0,1

YES

LEGACY_NDI,
DEATH_DOC

Optional

YES

LEGACY_NDI,
DEATH_DOC

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

listed, 2 if the cause is the second one
listed, and so forth).
DOCUMENT

A table that maintains information about a document (such as a case report form).

author

The person who completed the original
form.
The phone number of the person who
completed the original form.
Date the form or document was
completed or populated with information.
For example, when the chart abstraction
was completed.
A field indicating the number of the
document. For example, the certificate
number associated with a birth certificate.
The source code of the document, such as
A01 for Inpatient Record or A02 for
Outpatient Record.

author_phone
complete_dt

document_number
document_source_cd

3-30

March 13, 2019

NO

All

Optional

7 or 10 digits

NO

All

Optional

YYYYMMDD

YES

All

Required

NO

All

Optional

YES

All

Required

A01-Inpatient Record
A01.01-Acute Care Facility
A01.01.01-Infection Control
Practitioner
A01.01.02-OBGYN records
A01.01.02.01-Prenatal Care
records
A01.01.02.02-Labor and
Delivery records
A01.01.03-Pediatric records
A01.01.04-Birth records
A01.01.05-All other records
A01.02-Veteran's
Administration
A01.02.01-Infection Control
Practitioner
A01.02.02-All other records
A01.03-Military Hospital
A01.03.01-Infection Control
Practitioner
A01.03.02-OBGYN Records
A01.03.02.01-Prenatal Care
records

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
A01.03.02.02-Labor and
Delivery records
A01.03.03-Pediatric
Records
A01.03.04-All Other
Records
A01.04-Long term care
facility
A01.04.01-Nursing home
A01.04.02-Rehabilitation
center
A01.04.03-Drug treatment
program
A01.05-Hospice
A02-Outpatient Record
A02.01-HMO
A02.01.01-Hospitalassociated outpatient clinic
A02.01.02-Non-Hospital
associated outpatient clinic
A02.02-VA OP Clinic
A02.03-Private Physician
A02.03.01-Hospitalassociated outpatient clinic
A02.03.02-Non-Hospital
associated outpatient clinic
A02.04-Adult HIV Clinic
A02.04.01-Hospitalassociated outpatient clinic
A02.04.02-Non-Hospital
associated outpatient clinic
A02.05-Infectious Disease
Clinic
A02.05.01-Hospitalassociated outpatient clinic

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
A02.05.02-Non-Hospital
associated outpatient clinic
A02.06-County Health
Dept. Clinic
A02.07-Maternal HIV Clinic
A02.07.01-Hospitalassociated outpatient clinic
A02.07.02-Non-Hospital
associated outpatient clinic
A02.08-Prenatal Clinic or
Records
A02.08.01-Hospitalassociated outpatient clinic
A02.08.02-Non-Hospital
associated outpatient clinic
A02.09-Pediatric HIV Clinic
A02.09.01-Hospitalassociated outpatient clinic
A02.09.02-Non-Hospital
associated outpatient clinic
A02.10-Obstetrics and
Gynecology
A02.10.01-Hospitalassociated outpatient clinic
A02.10.02-Non-Hospital
associated outpatient clinic
A02.11-Pediatric Clinic
A02.11.01-Hospitalassociated outpatient clinic
A02.11.02-Non-Hospital
associated outpatient clinic
A02.12-TB Clinic
A02.12.01-Hospitalassociated outpatient clinic
A02.12.02-Non-Hospital
associated outpatient clinic
A02.13-HRSA-funded clinic
A02.14-Indian Health

3-32

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
Service clinic
A02.14.01-Hospitalassociated outpatient clinic
A02.14.02-Non-Hospital
associated outpatient clinic
A02.15-Early Intervention
Nurse
A02.15.01-Hospitalassociated outpatient clinic
A02.15.02-Non-Hospital
associated outpatient clinic
A02.16-Visiting Nurse
Service
A02.16.01-Hospitalassociated outpatient clinic
A02.16.02-Non-Hospital
associated outpatient clinic
A02.17-Hemophilia
Treatment Center
A02.17.01-Hospitalassociated outpatient clinic
A02.17.02-Non-Hospital
associated outpatient clinic
A02.18-Hospice
A02.18.01-Hospitalassociated outpatient clinic
A02.18.02-Non-Hospital
associated outpatient clinic
A02.19-Drug Treatment
Center
A02.19.01-Hospitalassociated outpatient clinic
A02.19.02-Non-Hospital
associated outpatient clinic
A02.20-Rehabilitation

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
Center
A02.20.01-Hospitalassociated outpatient clinic
A02.20.02-Non-Hospital
associated outpatient clinic
A02.25-Other Clinic
A02.25.01-Hospitalassociated outpatient clinic
A02.25.02-Non-Hospital
associated outpatient clinic
A03-Emergency Room
A04-Screening, Diagnosis
and Referral Agencies
A04.01-Blood Bank
A04.02-Drug Treatment
Clinic or Program
A04.03-Family Planning
Clinic
A04.04-HIV Case
Management Agency
A04.05-HIV Counseling and
Testing site
A04.06-Immigration
A04.07-Insurance report
A04.08-Job Corps
A04.09-Military
A04.10-Partner Counseling
and Referral Services
A04.11-STD Clinic
A04.12-Public health notes
A05-Laboratories
A05.01-Hospital laboratory
A05.02-State Laboratory
A05.03-Private Laboratory
A05.03.01-Reference
laboratory
A05.03.02-Other
Laboratory

3-34

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
A06-Other Databases of
information
A06.01-AIDS Drug
Assistance Program (ADAP)
A06.02-ASD Database
A06.03-Birth Certificate
A06.04-Birth Defects
Registry
A06.05-Other Cancer
Registry
A06.06-Database provided
by coroner
A06.07-Death Certificate
A06.08-EHRAP Database
A06.09-EPS Database
A06.10-HARS Database
A06.11-Health department
records
A06.12-Hepatitis Registry
A06.13-Hospital billing
summary or discharge
database
A06.14-HRSA HIV CARE
Database
A06.15-Immunization
registry
A06.16-Medicaid Records
A06.17-National Death
Index (NDI) Search
A06.18-Out of State Report
A06.19-Prison, Jail or other
Correctional Facility
A06.20-PSD Database
A06.21-State Disease
Registry

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
A06.22-SHAS Database
A06.23-SHDC Database
A06.24-STD Registry
A06.25-Tuberculosis
Registry
A06.27-Vital Statistics
(state/local)
A06.28-HARS NDI
A06.29-Routine Interstate
Duplicate Resolution (RIDR)
report
A06.30-Social Security
Death Master File (SSDMF)
or Social Security Death
Index (SSDI)
A06.31-Legacy TTH Pretest
A06.32-Legacy TTH Posttest
A06.33-Legacy Consent
A06.34-Medical Monitoring
Project (MMP)
A06.34.01-MMP Medical
Record Abstraction
A06.34.02-MMP Patient
Interview
A06.35-Fetal-Infant
Mortality Review (FIMR)
A06.35.01-FIMR Medical
Record Abstraction
A06.35.02-FIMR Patient
Interview
A06.50-Other Database or
Report
A07-Other Facility Records
A07.01-Prison, jail, or other
correctional facility
A07.02-Coroner not
associated with inpatient

3-36

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

document_type_cd

A code indicating the type of document,
such as 001 for Adult Case Report Form or
005 for Birth Certificate.

document_uid
ehars_uid
enter_by

A unique identifier for a document.
A unique identifier for a case or person.
The user ID of the person who entered the
information into eHARS, auto-populated
by the application.

Valid data element values
(lookup type, reference
table, or actual values)
facility
A10-Other source
A10.01-COPHI Investigation
A10.02-Patient interview
UNK-Unknown
No source defined
000-document.personView
001document.adultCaseReport
Doc
002document.pediatricReportD
oc
003document.harsAdultDoc
004-document.lab
005document.birthCertificateD
oc
006document.deathCertificate
Doc
009document.harsPediatricDoc
010-Supplemental Risk
Form
011-document.harsNdiDoc
012-document.tthDoc
013-document.consent
015-document.starhs

Transfer
to CDC

Document Source

Required/Optional

YES

All

System

YES
YES
NO

All
All
All

System
System
Optional

TABLE NAME
VARIABLES

enter_dt
facility_uid
initdocuid

initinvest
modify_dt
notes
provider_uid
pv_categ

pv_hcateg

receive_dt
rep_hlth_dept_cd

rep_hlth_dept_name
rpt_medium

3-38

DESCRIPTION

The system date when the document was
entered into eHARS.
Indicates the facility completing the form.
If this document contains follow up
information, this field captures the
document UID of the report that initiated
the investigation.
Did this document initiate a follow-up
investigation?
The date the document was last modified.
Notes or comments regarding the
document.
Indicates the provider completing the
form.
The Person View AIDS category at the time
the document was entered into eHARS.
(Note: This field was retired from usage
as of version 4.0)
The Person View HIV category at the time
the document was entered into the
system. (Note: This field was retired
from usage as of version 4.0)
The date the document was received at
the health department.
The health department reporting this
information to the site. The code consists
of the state abbreviation and either the
three digit FIPS county code (state + fips
county code), or the five digit FIPS place
code (state + fips place code).
The name of the reporting health
department.
An indication of the medium used to
transport the information to the site, such
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES

All

System

FACILITY_CODE (table)

YES

Optional - System

YES

ACRF, PCRF,
LEGACY_CONSENT,
LEGACY_TTH
All

YES_NO_UNK

YES

All

Optional

YYYYMMDD

YES
NO

All
All

Optional
Optional

PROVIDER_CODE (table)

NO

Optional - System

YES

ACRF, PCRF,
LEGACY_CONSENT,
LEGACY_TTH
All

YES

All

System

YYYYMMDD

YES

All

Optional

two character state
abbreviation + three digit
FIPS county code or five
digit FIPS place code

YES

All

Optional

YES

All

Required

YES

All

Optional

1 - Paper form, field visit
2 - Paper form, mailed

Required if follow-up
document

System

TABLE NAME
VARIABLES

DESCRIPTION

as paper form, faxed or diskette, mailed.

ship_flag

site_cd
status_flag

surv_method

FACILITY_CODE
city_fips
city_name
country_cd
country_usd
county_fips
county_name
email
facility_type_cd

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

3 - Paper form, faxed
4 - Telephone
5 - Electronic transfer,
Internet
6 - Diskette, mailed
0-9999

YES

All

System

SITE_CODE

YES

All

System

DOCUMENT_STATUS (nonYES
pv documents),
PERSON_VIEW_STATUS (pv
documents)
A field indicating whether the report was
A - Active
YES
obtained via active or passive surveillance. F - Follow-up
P - Passive
R - Reabstraction
U - Unknown
A table that maintains information for selecting and identifying healthcare facilities.

All

System

All

Required

City FIPS code for the facility's address.
City name associated with the facility's
address.
ISO country code for the facility's address.
U.S. dependency code for the facility's
address, if applicable.
County FIPS code for the facility's address.
County name associated with the facility's
address.
The email address of the facility.
A code indicating the type of healthcare
facility.

A value indicating if the document/Person
View needs to be transferred to state
health department (satellite installations)
or to CDC.
A unique identifier representing the
reporting site or location where eHARS is
installed.
A value indicating the status of the
document or Person View.

FIPS_CITY (table)
FIPS_CITY (table)

YES
YES

N/A
N/A

Optional
Optional

COUNTRY_CODE (table)
COUNTRY_CODE (table)

YES
YES

N/A
N/A

Optional
Optional

FIPS_COUNTY (table)
FIPS_COUNTY (table)

YES
YES

N/A
N/A

Optional
Optional

NO
YES

N/A
N/A

Optional
Required

F.OTH-Facility/Other
F.UNK-Facility/Unknown

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
F01-Inpatient Facility
F01.01-Inpatient
Facility/Hospital
F01.04-Inpatient
Facility/Long Term Care
F01.50-Inpatient
Facility/Drug Treatment
F01.OTH-Inpatient
Facility/Other
F01.UNK -Inpatient
Facility/Unknown
F02-Outpatient Facility
F02.01-Outpatient
Facility/HMO Clinic
F02.03-Outpatient
Facility/Private Physician's
Office
F02.04-Outpatient
Facility/Adult HIV Clinic
F02.05-Outpatient
Facility/Infectious Disease
Clinic
F02.09-Outpatient
Facility/Pediatric HIV
Specialty Clinic
F02.10-Outpatient
Facility/Obstetrics and
Gynecology Clinic
F02.11-Outpatient
Facility/Pediatric Clinic
F02.12-Outpatient
Facility/TB Clinic
F02.16-Outpatient
Facility/Home Health
Agency
F02.17-Outpatient
Facility/Hemophilia
Treatment Center

3-40

March 13, 2019

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
F02.18-Outpatient
Facility/Hospice
F02.19-Outpatient
Facility/Drug Treatment
Center
F02.25-Outpatient
Facility/Other Clinic
F02.50-Outpatient
Facility/ACTG Site
F02.51-Outpatient
Facility/Community Health
Center
F02.52-Outpatient
Facility/Employee Health
Clinic
F02.53-Outpatient
Facility/Health
Department/Public Health
Clinic
F02.54-Outpatient
Facility/Mobile Clinic
F02.55-Outpatient
Facility/Non-mobile Street
Outreach
F02.56-Outpatient
Facility/PACTG Site
F02.57-Outpatient
Facility/Primary Care Clinic,
Not Specified
F02.58-Outpatient
Facility/School or University
Clinic
F02.OTH-Outpatient
Facility/Other
F02.UNK -Outpatient

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

facility_uid
fax
funding_cd
funding_flag
name1
name2
phone
setting_cd
3-42

DESCRIPTION

A unique identifier for a healthcare
facility.
The fax number of the facility.
A code that indicates the type of HRSA
funding a facility receives.
Does the facility receive HRSA funding?
Primary name of the facility.
Secondary or alternative name of the
facility.
Phone number of the facility.
A code identifying the setting of the
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
Facility/Unknown
F03-Emergency Room
F04-Screening, Diagnostic,
Referral Agency (S,D,R)
F04.01-(S,D,R) Blood Bank
or Plasma Center
F04.02-(S,D,R) Drug
Treatment Center
F04.03-(S,D,R) Family
Planning Clinic
F04.04-(S,D,R) HIV Case
Management Agency
F04.05-(S,D,R) HIV
Counseling and Testing Site
F04.07-(S,D,R) Insurance
Screening
F04.11-(S,D,R) STD Clinic
F04.OTH-(S,D,R) Other
F04.UNK -(S,D,R) Unknown
F05-Laboratory
F07-Other Specific Facility
F07.01-Other Specific
Facility/Correctional Facility
F07.02-Other Specific
Facility/Coroner or Medical
Examiner

FUNDING_CD
YES_NO

1-Public, unspecified

Transfer
to CDC

Document Source

Required/Optional

YES

N/A

System

NO
YES

N/A
N/A

Optional
Optional

YES
YES
YES

N/A
N/A
N/A

Optional
Optional
Optional

NO
YES

N/A
N/A

Optional
Optional

TABLE NAME
VARIABLES

ship_flag
state_cd
street_address1
street_address2
zip_cd
FACILITY_EVENT

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

facility, such as Federal, VA.

2-Federal, VA
3-Federal, IHS
4-Federal, military
5-Federal, corrections
6-Federal,
other/unspecified
7-State
8-County/Parish
9-City/Town/Township
10-Private
999-Unknown
0 = Do not ship, 1 = Ship to
CDC

Transfer
to CDC

Document Source

Required/Optional

A field used by the application to
NO
N/A
Optional
determine if the information for this
facility needs to be transferred to CDC.
State postal code of the facility's address.
STATE_CODES
YES
N/A
Optional
Facility’s primary street address.
NO
N/A
Optional
Facility’s secondary street address.
NO
N/A
Optional
Zip code for the facility's address.
ZIP_CITY (table)
YES
N/A
Optional
A table that maintains information pertaining to a person's events that involve a facility, such as facility at birth or facility at HIV
diagnosis.

doc_belongs_to

Indicates if the facility event data (such as
facility at HIV dx or facility at birth) belong
to PERSON or CHILDn.

document_uid

A unique identifier for a document.

event_cd

A code that indicates the type of event
that occurred.

PERSON, MOTHER, CHILD

01 - Facility of HIV diagnosis
02 - Facility of AIDS
diagnosis
03 - Facility of perinatal
exposure

YES

All except
DEATH_DOC and
LAB_DOC

Optional

YES

All except
DEATH_DOC and
LAB_DOC

System

YES

All except
DEATH_DOC and
LAB_DOC

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

All except
DEATH_DOC and
LAB_DOC

Optional - System

PROVIDER_CODE (table)

NO

All except
DEATH_DOC and
LAB_DOC

Optional - System

YES

System

ID_CODE

YES
YES

ACRF,
LEGACY_ADULT,
PCRF,
LEGACY_PEDIATRIC,
BC
All
All

1-99999999

YES

All

YES

All

provider_uid

The unique identifier of the provider
associated with this event.

ID
doc_belongs_to

A table that maintains information on a person's identifiers.
Indicates who the identifier belongs to:
PERSON, MOTHER, CHILDn
PERSON, MOTHER, or CHILDn.

document_uid
id_cd

A unique identifier for a document.
Code that indicates the type of identifier
assigned to a person.

id_seq

Sequence identifier for a person's
identification codes. A person can have
multiple identification code types
(id_cd_type) on the Person View
document only.
The value of the person's identifier.

001
003
004
005
3-44

Required/Optional

YES

The unique identifier of the facility
associated with this event.

ID_CODE

Document Source

05 - Hospital of birth
07 - Facility where child was
transferred within 24 hours
of delivery
FACILITY_CODE (table)

facility_uid

id_value

Transfer
to CDC

System
Refer to ID_CODE table
for requirements for
each variable
System

Refer to ID_CODE table
for valid data element
values for each variable
A table that contains all distinct ID.id_cd values and associated descriptions, including any locally-defined ID types.
*Required for the stateno associated with the state of report and the cityno associated with the applicable city of report.
FL STATENO
YES
All
Optional*
HRSA URN
NO
All
Optional
Medicaid Number
NO
All
Optional
GA STATENO
YES
All
Optional*
March 13, 2019

TABLE NAME
VARIABLES

006
007
008
009
010
011
012
013
015
016
017
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036

DESCRIPTION

PA STATENO
Ryan White Number
AIDS Drug Assistance Program (ADAP)
Number
STD*MIS Number
Prison Number
RVCT (TB) Number
Social Security Number (SSN)
Social Security Number Alias
CA Non-named Code (reported)
CA Non-named Code (verified)
CT Coded Identifier (reported)
DC Unique Id (reported)
DC Unique Id (verified)
DE Coded Identifier (reported)
DE Coded Identifier (verified)
HI Unnamed Test Code (reported)
HI Unnamed Test code (verified)
IL Patient Code Number (reported)
IL Patient Code Number (verified)
Philadelphia, PA Unique Code (reported)
Philadelphia, PA Unique Code (verified)
MA Coded Identifier (reported)
MA Coded Identifier (verified)
MD Unique Identifier (reported)
MD Unique Identifier (verified)
ME Coded Identifier (reported)
ME Coded Identifier (verified)
MT Coded Identifier (reported)
MT Coded Identifier (verified)

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES
NO
NO

All
All
All

Optional*
Optional
Optional

YES
NO
YES
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All

Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

TABLE NAME
VARIABLES

037
038
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
059
067
069
070
071
072
073
074
075
076
077
078
079
080
3-46

DESCRIPTION

OR Coded Identifier (reported)
OR Coded Identifier (verified)
RI Coded Identifier (reported)
RI Coded Identifier (verified)
VT Non-named Code (reported)
VT Non-named Code (verified)
WA Non-named Coded Id (reported)
WA Non-named Coded Id (verified)
PATNO (HARS)
HIVNO (HARS)
Medical Record Number (MEDRECNO)
TX STATENO
Houston, TX CITYNO
LA STATENO
WA STATENO
MI STATENO
AL STATENO
NJ STATENO
Counseling and Testing
WA Non-named Code (generated)
DC Unique Id (generated)
DE Coded Identifier (generated)
HI Unnamed Test Code (generated)
IL Patient Code Number (generated)
Philadelphia, PA Unique Code (generated)
MA Coded Identifier (generated)
MD Unique Identifier (generated)
ME Coded Identifier (generated)
MT Coded Identifier (generated)
OR Coded Identifier (generated)
PR Coded Identifier (retired)
VT Non-named Code (generated)
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
NO
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

Document Source

All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All

Required/Optional

Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

TABLE NAME
VARIABLES

081
082
083
084
086
090
092
094
096
098
100
102
104
106
108
112
114
132
133
134
135
136
137
138
139
140
141
142

DESCRIPTION

CA Non-named Code (generated)
CT Coded Identifier (generated)
RI Coded Identifier (generated)
WA Non-named Code Alias (reported)
CA Non-named Code Alias (reported)
DC Unique Id Alias (reported)
DE Coded Identifier Alias (reported)
HI Unnamed Test Code Alias (reported)
IL Patient Code Number Alias (reported)
Philadelphia, PA Unique Code Alias
(reported)
MA Coded Identifier Alias (reported)
MD Unique Identifier Alias (reported)
ME Coded Identifier Alias (reported)
MT Coded Identifier Alias (reported)
OR Coded Identifier Alias (reported)
RI Coded Identifier Alias (reported)
VT Non-named Code Alias (reported)
UCSF Patient Identifier
Reporting Health Department Number
(generic cityno)
AK STATENO
AZ STATENO
AR STATENO
CA STATENO
CO STATENO
CT STATENO
DE STATENO
HI STATENO
ID STATENO

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

All
All
All
All
All
All
All
All
All
All

Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

NO
NO
NO
NO
NO
NO
NO
NO
YES

All
All
All
All
All
All
All
All
All

Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional

YES
YES
YES
YES
YES
YES
YES
YES
YES

All
All
All
All
All
All
All
All
All

Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*

TABLE NAME
VARIABLES

143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
3-48

DESCRIPTION

IL STATENO
IN STATENO
IA STATENO
KS STATENO
KY STATENO
ME STATENO
MD STATENO
MA STATENO
MN STATENO
MS STATENO
MO STATENO
MT STATENO
NE STATENO
UT STATENO
VT STATENO
VA STATENO
WV STATENO
WI STATENO
WY STATENO
NV STATENO
NH STATENO
NM STATENO
NY STATENO
NC STATENO
ND STATENO
OH STATENO
OK STATENO
OR STATENO
RI STATENO
SC STATENO
SD STATENO
TN STATENO

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
March 13, 2019

Document Source

All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All

Required/Optional

Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*

TABLE NAME
VARIABLES

175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
195
196
197
198
199
INVESTIGATION_CASE
document_uid
invest_case_seq
invest_type_cd
invest_ident_method

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

New York, NY CITYNO
American Samoa STATENO
Mariana Islands STATENO
DC STATENO
Guam STATENO
Puerto Rico STATENO
Virgin Islands STATENO
San Francisco, CA CITYNO
Los Angeles, CA CITYNO
Chicago, IL CITYNO
Philadelphia, PA CITYNO
PATNO (ASD)
INS Number
KY Unique Code Alias (Retired)
Tracking ID
Generic ID
PEMS Client Unique Key
PEMS Local Client Key
PEMS Form ID
Palau STATENO
Marshall Islands STATENO
MMP PARID
FIMR ID
Federated States of Micronesia STATENO
A table that maintains the details of the HIV case investigation.
A unique identifier for a document.
Sequence number to make the record
unique.
Type of investigation
0 - Transmission Cluster
1 - Not in care
How person was first identified as needing 01 - Health department HIV

Transfer
to CDC

Document Source

Required/Optional

YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
YES

All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All
All

Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional*
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional*

YES
YES

ACRF
ACRF

System
System

YES

ACRF

Required

YES

ACRF

Required

TABLE NAME
VARIABLES

DESCRIPTION

investigation.

invest_ident_dt

Date first identified as needing
investigation

invest_incl

Included in investigation.

invest_start_dt
invest_dispo

Date investigation opened.
Investigation disposition.

invest_dispo_dt
invest_dispo_method

Investigation disposition date.
Basis of investigation disposition.

int_dispo_dt
int_dispo

Intervention disposition date.
Intervention disposition.

3-50

March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
surveillance system (e.g.,
eHARS)
02 - Health department
integrated data system
03 - Provider report
04 - Transmission cluster
investigation
05 - Elevated viral load
investigation
06 - Partner services
investigation
07 - Medical Monitoring
Project (MMP)
88 - Other
YYYYMMDD
Y - Included in investigation
N - Excluded from
investigation
YYYYMMDD
1 - Deceased
2 - Resides out of
jurisdiction
3 - In care
4 - Not in care
5 - Unable to determine
YYYYMMDD
1 - Database/record search,
only
2 - Patient contact/field
investigation, only
3 - Database/record search
and patient contact/field
investigation
YYYYMMDD
1 –-No linkage/reengagement intervention

Transfer
to CDC

Document Source

Required/Optional

YES

ACRF

Required

YES

ACRF

Required

YES
YES

ACRF
ACRF

Required
Required

YES
YES

ACRF
ACRF

Required
Required

YES
YES

ACRF
ACRF

Required
Required

TABLE NAME
VARIABLES

INVESTIGATION_CLUST
ER
cluster_uid
cluster_ident_method

document_uid
invest_cluster_seq

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

initiated
2 - Linkage/re-engagement
intervention declined by
client
3 - Returned to care before
linkage/re-engagement
intervention was initiated
4 - Linkage/re-engagement
intervention initiated, not
successfully linked to/reengaged in care
5 - Linked to/re-engaged in
care, documented
6 - Linked to/re-engaged in
care, client self-report, only
7 - Linkage/re-engagement
status unknown
A table that maintains the details of molecular cluster investigation.
Unique cluster ID number.
Method of cluster identification.

A unique identifier for a document.
Sequence number to make the record
unique.

A-Z, 0-9,-,_, blank
01 - State/local molecular
cluster analysis
02 - National molecular
cluster analysis
03 - State/local time-space
cluster analysis
04 - National time-space
cluster analysis
05 - Provider notification
06 - Partner services
notification
88 - Other

YES
YES

ACRF
ACRF

Required
Required

YES
YES

ACRF
ACRF

System
System

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Required/Optional

How person was identified as part of this
cluster.

ACRF

Required

person_ident_dt

Date person was identified as part of this
YES
ACRF
cluster.
A table that maintains information on a person's diagnostic tests and STARHS results.

Required

An identifier assigned by the lab to a
specimen when received; acts as a
tracking mechanism for the specimen.
For application use, a code associating a
diagnostic test with the HIV/AIDS case
definition algorithm.

accession_number

YES

Document Source

person_ident_met

LAB

1 - Through
analysis/notification
2 - Through investigation
YYYYMMDD

Transfer
to CDC

NO

ACRF, PCRF, LAB_DOC

Optional

LAB_TEST_CODE (table)

YES

System

The CLIA provider number of the
laboratory that performed the test.
Notes or comments regarding a lab test
entered by a user. These values are
transferred to CDC.
A unique identifier for a document.

CLIA_CODE (table)

YES

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF, LAB_DOC

YES

ACRF, PCRF, LAB_DOC

Optional

YES

System

The unique identifier of the facility that
ordered the test.
Sequence identifier for a person's
laboratory results.

FACILITY_CODE (table)

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF, LAB_DOC

System

lab_test_cd

The eHARS defined codes to identify lab
tests

LAB_TEST_CODE (table)

YES

lab_test_type

The type of lab test.

RAPID_TEST_TYPE
(As of version 4.0 the
values below have been
retired from usage.)
TYPE_OF_KIT

YES

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC

case_cd

clia_uid
comments
document_uid

facility_uid
lab_seq

3-52

March 13, 2019

YES
YES

Optional

Optional - System

Required

Optional if the test is
rapid

TABLE NAME
VARIABLES

manufacturer

DESCRIPTION

The manufacturer of the test (applicable
to viral load tests only)

Valid data element values
(lookup type, reference
table, or actual values)
TYPE_OF_KIT_STARHS
TYPE_OF_KIT_VL
01-Bayer Diagnostics
02-Organon Teknika
03-Roche Molecular
Systems Inc.
04-Abbott Laboratories
05-ABBOTT Molecular Inc.
06-Alere
07-Avioq Inc.
08-BioLife Plasma Services
09-bioLytical Laboratories
Inc.
10-Bio-Rad Laboratories
11-Celera Diagnostics
12-Chembio Diagnostic
Systems Inc.
13-Gen-Probe Inc.
14-Home Access Health
Corp.
15-Maxim Biomedical Inc.
16-MedMira Laboratories
Inc.
17-National Genetics
Institute
18-OraSure Technologies
19-Ortho-Clinical
Diagnostics Inc.
21-Sanochemia
Pharmazeutika AG
22-Siemens Healthcare
Diagnostics Inc.
23-Trinity Biotech
24-Becton Dickinson
25-Beckman Coulter

Transfer
to CDC

YES

Document Source

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC

Required/Optional

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

26-Cytognos
27-Guava Technologies
28-Partec
29-Invitrogen/Dynal
biotech
30-PointCare technologies
31-Sysmex
32-i+MED Laboratories Co.
Ltd.
33-Visible Genetics
34-Applied Biosystems
35-Virco
36-bioMerieux, Inc
37-Siemens Medical
Solutions Diagnostics
38-Chiron Corporation
40-Streck
88-Other
99-Unknown
PROVIDER_CODE (table)

NO

provider_uid

The unique identifier of the provider who
ordered the test.

receive_dt

The date the lab that performed the test
received the specimen from either a
healthcare provider or another laboratory.

YYYYMMDD

YES

result

The result value including the optical
density for STARHS.

LAB_RESULT_VALUE (but
depends upon the test)

YES

result_interpretation

An interpretation of the lab result. For
viral load tests, values include: within
range =, below range (limit) <, above
range (limit) >. For STARHS tests the
STARHS_RESULT values as found in
LOOKUP_CODE table.

RESULT_INTERPRETATION For viral load tests
STARHS_RESULT - For
STARHS tests
Old HARS value "I"
(indeterminate) [viewable
only]

YES

3-54

March 13, 2019

Document Source

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC

Required/Optional

Optional-System

Optional

Required when entering
a lab test
Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

result_range_lower

The lower boundary reference range or
detection limit for viral load.

0-999.999,999

YES

result_range_upper

The upper boundary reference range or
detection limit for viral load.

0-999.999,999

YES

result_rpt_dt

The date the test result was reported or
processed at the lab.

YYYYMMDD

YES

result_units

The reported units.

RESULT_UNITS_CD4,
RESULT_UNITS

YES

sample_dt

The date the specimen was collected.

YYYYMMDD

YES

sample_id

A unique identifier used to distinguish
samples; may be specimen number or ID.
The type of specimen collected.

specimen

sreason

The reason the STARHS specimen was not
sent for testing.

starhs_sample_id

If this is a confirmatory test aliquoted for

BLD - Blood
OTH - Other
SAL - Saliva
UNK - Unknown
URN - Urine
1 - Quantity not sufficient
2 - Specimen never
received at public lab
3 - Specimen broke in
transit
4 - Other
5 - Not sufficient antibodies

Document Source

Required/Optional

Optional

NO

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF, LAB_DOC

YES

ACRF, PCRF, LAB_DOC

Optional

YES

ACRF, PCRF, LAB_DOC

Optional

YES

ACRF, PCRF, LAB_DOC

If lab_test_cd=EC-023,

Optional

Optional

Required when entering
a CD4 test
Required when entering
a lab test
Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

STARHS, the STARHS specimen ID.
LAB_ANALYTE
document_uid
lab_seq
lab_test_cd
result_interpretation

A table that contains the HIV-1/2 Ag/Ab and Type-Differentiating Immunoassay lab test’s analyte results.
A unique identifier for a document.
YES
ACRF, PCRF, LAB_DOC
Sequence identifier for a person's
YES
ACRF, PCRF, LAB_DOC
laboratory results.
The eHARS defined codes to identify lab
LAB_TEST_CODE (table)
YES
ACRF, PCRF, LAB_DOC
tests
An interpretation of the lab result.
RESULT_INT_ANALYTE
YES
ACRF, PCRF, LAB_DOC

Required/Optional

EC-024, EC-025, EC-026,
or EC-027 then this
variable is REQUIRED
System
System
Required

The result value.
0.00000-9999.99999, <, >, =
YES
The reported units
IDX
YES
A table that contains the gene sequence from a person's genotype diagnostic test.
A unique identifier for a document.
YES
The genotype sequence result from a
GENE_VALIDATION
YES
genotype diagnostic test.
Sequence identifier for a person's
YES
laboratory results.
A table that maintains information on a person’s observations.
An internal unique identifier for a
YES
document. For person-based local fields,
the ehars_uid is stored in this field. For
document-based local fields, the
document_uid is stored in this field.
An internal unique identifier for an
OBSERVATION_CODE
YES
observation.
(table)

ACRF, PCRF, LAB_DOC
ACRF, PCRF, LAB_DOC

Required when entering
a lab test
Optional
System

ACRF, PCRF, LAB_DOC
ACRF, PCRF, LAB_DOC

System
Required

ACRF, PCRF, LAB_DOC

System

All

System

All

obs_value

The value for the observed object.

YES

All

OBSERVATION_CODE

A table that contains all distinct obs_value and associated descriptions.

Refer to
OBSERVATION_CODE
table for requirements
for each variable
Refer to
OBSERVATION_CODE
table for valid data
element values for each
variable

1

Report status

YES

All

Optional

result
result_units
LAB_GENOTYPE
document_uid
genotype_sequence
lab_seq
OBSERVATION
document_uid

obs_uid

3-56

March 13, 2019

TABLE NAME
VARIABLES

2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

DESCRIPTION

HARS Legacy - Laboratory name
HARS Legacy - Other facility type at HIV
diagnosis (specify)
HARS Legacy - Has patient received a
physical exam for this condition?
HARS Legacy - Other facility type at
perinatal exposure (specify)
If HIV laboratory tests were not
documented, is HIV diagnosis documented
by a physician?
Date patient was confirmed by a physician
as HIV infected
Entered age at HIV diagnosis (years)
Entered age at AIDS diagnosis (years)
Clinical record reviewed
Date patient was diagnosed as
asymptomatic
Date patient was diagnosed as
symptomatic
HARS Legacy - Other facility type at AIDS
diagnosis (specify)
Has patient been informed of his/her HIV
infection?
By whom patient's partners will be
notified and counseled about their HIV
exposure
Is patient receiving or has patient been
referred for medical services?
Is patient receiving or has patient been
referred for substance abuse treatment
services?
HARS Legacy - Follow up date
HARS Legacy - Follow up status of patient

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES
YES

All
All

Legacy HARS
Legacy HARS

YES

All

Legacy HARS

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Required if laboratory
test not documented

YYYYMMDD

YES

All

YES_NO
YYYYMMDD

YES
YES
YES
YES

All
All
All
All

Required if laboratory
test not documented
and physician diagnosis
Optional
Optional
Optional
Optional

YYYYMMDD

YES

All

Optional

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Optional

PATIENT_NOTIFIER

YES

All

Optional

YES_NO_UNK

YES

All

Optional

YES_NO_NA_UNK

YES

All

Optional

1=Active follow-up

YES
YES

All
All

Legacy HARS
Legacy HARS

YES_NO_UNK

TABLE NAME
VARIABLES

20
21
22
23
24
25
26
27
28
29
31

32
33
34
35
39
40
41

3-58

DESCRIPTION

HARS Legacy - Laboratory ID number
HARS Legacy - Did patient have
heterosexual relations with a person born
outside of the U.S.?
HARS Legacy - Country of person with
whom patient had heterosexual relations
Patient is receiving or has been referred
for OB-GYN services
Is patient currently pregnant?
Has patient delivered live-born infant?
HARS Legacy - Has child's mother had sex
with a man born outside of the U.S.?
HARS Legacy - Is patient receiving HIV
prophylactic therapy?
HARS Legacy - Has patient been referred
for treatment?
HARS Legacy - Country of man with whom
child's mother had sex
HARS Legacy - Method of partner
notification
HARS Legacy - Source of AIDS report
HARS Legacy - Source of HIV report
HARS Legacy - Source of AIDS report
(specify)
HARS Legacy - Source of HIV report
(specify)
Date of last medical evaluation
Date of initial evaluation for HIV infection
Was reason for initial HIV evaluation due
to clinical signs/symptoms?
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
2=Moved from state
3=Provider out of state
4=Lost to follow-up
9=Unknown

Transfer
to CDC

Document Source

Required/Optional

YES_NO_UNK

YES
YES

All
All

Legacy HARS
Legacy HARS

See HARS country codes

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Optional

YES_NO_UNK
YES_NO_UNK
YES_NO_UNK

YES
YES
YES

All
All
All

Required
Optional
Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

See HARS country codes

YES

All

Legacy HARS

1=Patient referred
2=Health department
referred
8=Other provider
LEGACY_SOURCE
LEGACY_SOURCE

YES

All

Legacy HARS

YES
YES
YES

All
All
All

Legacy HARS
Legacy HARS
Legacy HARS

YES

All

Legacy HARS

YES
YES
YES

All
All
All

Optional
Optional
Optional

YYYYMMDD
YYYYMMDD
YES_NO_UNK

TABLE NAME
VARIABLES

42
43
44

45
46
47
48

DESCRIPTION

Date of mother's first HIV positive test
Was mother counseled about HIV testing
during this pregnancy, labor, or delivery?
eHARS Retired –– If HIV tests were not
positive or were not done, does this
patient have an immunodeficiency that
would disqualify him/her from AIDS case
definition?
Is patient confirmed by a physician as not
HIV infected?
Date patient confirmed by physician as
not HIV infected
Is child's birth history available?
Entered diagnostic status at report

58

HARS Legacy - Mother's type of
coagulation disorder

74

HARS Legacy - Was mother diagnosed with
HIV/AIDS?
HARS Legacy - Was mother diagnosed with
HIV/AIDS prior to child's birth?
Has child received neonatal zidovudine?
Has child received other neonatal antiretroviral therapy?
Has patient received anti-retroviral
therapy?
Has patient received PCP prophylaxis?
Date PCP prophylaxis started

75
76
78
81
83
84

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES_NO_UNK
YES_NO_UNK

YES
YES

All
All

Optional
Optional

YES_NO_UNK

YES

All

Optional

YES_NO_UNK

YES

All

Optional

YYYYMMDD

YES

All

Optional

YES_NO_UNK
1 - Adult HIV
2 - Adult AIDS
3 - Perinatal HIV exposure
4 - Pediatric HIV
5 - Pediatric AIDS
6 - Pediatric seroreverter
9 - Unknown
1=Hemophilia A
2=Hemophilia B
8=Other disorder
YES_NO_UNK

YES
YES

All
All

Optional
Optional

YES

All

Legacy HARS

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

YES_NO_UNK
YES_NO_UNK

YES
YES

All
All

Retired
Retired

YES_NO_UNK

YES

All

Retired

YES_NO_UNK
YYYYMMDD

YES
YES

All
All

Optional
Optional

TABLE NAME
VARIABLES

86
87
88

DESCRIPTION

Is patient enrolled in government/other
clinical trial?
Is patient enrolled at clinic?
HARS Legacy - Primary source of
reimbursement for medical treatment

89

Child's primary caretaker

90

HARS Legacy - For pediatric presumptive
AIDS before 10/94, was lymphocyte count
low (< 1000 ul)?
HARS Legacy - For pediatric presumptive
AIDS before 10/94, was CD4/CD8 ratio low
(< 1000 ul)?
HARS Legacy - For pediatric presumptive
AIDS before 10/94, total serum
immunoglobulins category

91
92

93
94
95

3-60

HARS Legacy - For pediatric presumptive
AIDS before 10/94, highest total serum
immunoglobulins value (mg/dl)
HARS Legacy - For pediatric presumptive
AIDS before 10/94, date of highest total
serum immunoglobulins
HARS Legacy - Was mother known to be
uninfected after child's birth?
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

PATIENT_ENROLLED_TRIAL

YES

All

Optional

PATIENT_ENROLLED_CLINIC
1=Medicaid
2=Private coverage
3=No coverage
4=Other public fund
7=Government program
9=Unknown
1 - Biological parent(s)
2 - Other relative
3 - Foster/Adoptive parent,
relative
4 - Foster/Adoptive parent,
unrelated
7 - Social service agency
8 - Other (please specify in
comments)
9 - Unknown
YES_NO_UNK

YES
YES

All
All

Optional
Legacy HARS

YES

All

Optional

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

1=<1500 mg/dl
2=1500-2500
3=>2500 mg/dl
9=Unknown

YES

All

Legacy HARS

YES

All

Legacy HARS

YES

All

Legacy HARS

YES

All

Legacy HARS

YES_NO_UNK

TABLE NAME
VARIABLES

96
99
100

101
102
114
115
116

DESCRIPTION

HARS Legacy - Scheduled follow-up: TB
update
HARS Legacy - Scheduled follow-up:
heterosexual case update
HARS Legacy - Father's birth place

HARS Legacy - Father's country of birth
HARS Legacy - Father's U.S. dependency of
birth
Entered age at HIV diagnosis (months)
Entered age at AIDS diagnosis (months)
HARS Legacy - Clinical status assessed
within one month of initial report

118

HARS Legacy - NDI match category

128
138
139
179
180

HARS Legacy - Scheduled follow-up:
immunologic case update
HARS Legacy - Physician name
HARS Legacy - Patient name
HARS Legacy - Comments from ARS
HARS Legacy - Was this child referred?

181

HARS Legacy - Comment line 1

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

range: 0-9, A-Z

YES

All

Legacy HARS

range: 0-9, A-Z

YES

All

Legacy HARS

1=US
7=US possession
8=Other
9=Unknown
See HARS country codes
See HARS US dependency
codes

YES

All

Legacy HARS

YES
YES

All
All

Legacy HARS
Legacy HARS

YES
YES
YES

All
All
All

Optional
Optional
Legacy HARS

YES

All

Legacy HARS

YES

All

Legacy HARS

YES
YES
YES
YES

All
All
All
All

Legacy HARS
Legacy HARS
Legacy HARS
Legacy HARS

YES

All

Legacy HARS

1=Asymptomatic
2=Symptomatic for
HIV/AIDS
1=Death not previously
known
2=Death previously known;
certificate identified by NDI
3=Death and certificate
previously identified
range: 0-9, A-Z

1=Yes, by health dept.
2=Yes, by health
care/provider
3=No, family refused
4=No
9=Unknown

TABLE NAME
VARIABLES

182
183
184
186
187
189
190
192
194
196
197
198
199
200
202
204
205
206
207
208
3-62

DESCRIPTION

HARS Legacy - Comment line 2
HARS Legacy - Comment line 3
HARS Legacy - Comment line 4
HARS Legacy - Date initial AIDS form
completed
HARS Legacy - State GSA geographic code
of current residence
HARS Legacy - Form (Adult of Pediatric)
HARS Legacy - Date initial HIV form
completed
HARS Legacy - Date of HIV diagnosis
reported at facility
HARS Legacy - Date of AIDS diagnosis
reported at facility
HARS Legacy - State GSA geographic code
of residence at HIV diagnosis
HARS Legacy - State GSA geographic code
of facility at HIV diagnosis
HARS Legacy - Has child received IVIG
therapy?
HARS Legacy - Mother received blood
products
HARS Legacy - Date of perinatal HIV
exposure reported at facility
HARS Legacy - State GSA geographic code
of facility at perinatal HIV exposure
HARS Legacy - State GSA geographic code
of residence at AIDS diagnosis
HARS Legacy - Record shipment to CDC
indicator
HARS Legacy - State GSA geographic code
of facility at AIDS diagnosis
HARS Legacy - State GSA geographic code
of reporting state
HARS Legacy - Record status
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YYYYMMDD

YES
YES
YES
YES

All
All
All
All

Legacy HARS
Legacy HARS
Legacy HARS
Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

A=Adult
P=Pediatric
YYYYMMDD

YES

All

Legacy HARS

YES

All

Legacy HARS

YYYYMMDD

YES

All

Legacy HARS

YYYYMMDD

YES

All

Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

YES_NO_UNK

YES

All

Legacy HARS

YYYYMMDD

YES

All

Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

N=No
Y, 2, ….=Yes
(FIPS_CITY.state_fips)

YES

All

Legacy HARS

YES

All

Legacy HARS

(FIPS_CITY.state_fips)

YES

All

Legacy HARS

A - Active record
B - Deleted record

YES

All

Legacy HARS

TABLE NAME
VARIABLES

210
211
212
220

DESCRIPTION

HARS Legacy - Physician phone
HARS Legacy - Reporting state
HARS Legacy - Mother receive any other
anti-retroviral medication during
pregnancy (specify)
Primary source of reimbursement for
medical treatment at time of AIDS
diagnosis

Valid data element values
(lookup type, reference
table, or actual values)
E - Fields in error
F - Deleted with fields in
error
R – Required fields missing
S – Deleted with reqd fields
missing
V - Pending verification
W - Deleted before verified
X – Reuse record in
Database
Z – ID number change
(FIPS_CITY.state_cd)

01 - CHAMPUS/TRICARE
02 - CHIP
03 - Medicaid
04 - Medicaid, pending
05 - Medicare
06 - Other public funding
07 - Private insurance,
HMO
08 - Private insurance, PPO
09 - Private insurance,
unspecified
10 - Self insured
11 - State funded, COBRA
12 - State funded, other
13 - State funded,
unspecified
14 - VA
18 - No health insurance
88 - Other

Transfer
to CDC

Document Source

Required/Optional

YES
YES
YES

All
All
All

Legacy HARS
Legacy HARS
Legacy HARS

YES

All

Optional

TABLE NAME
VARIABLES

DESCRIPTION

221

Primary source of reimbursement for
medical treatment at time of HIV
diagnosis

222

Did the documented laboratory test
results meet approved alternate HIV
testing algorithm criteria?
Specimen collection date of earliest
positive test for the approved alternative
HIV testing algorithm
Ever taken any ARVs?
Main source of antiretroviral (ARV) use
information

223
224
225

227
229
230

3-64

Date patient reported information
Date of last use of PCP prophylaxis
eHARS Retired -Did mother receive
zidovudine(ZDV,AZT) prior to this
pregnancy?
March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)
99 - Unknown
01 - CHAMPUS/TRICARE
02 - CHIP
03 - Medicaid
04 - Medicaid, pending
05 - Medicare
06 - Other public funding
07 - Private insurance,
HMO
08 - Private insurance, PPO
09 - Private insurance,
unspecified
10 - Self insured
11 - State funded, COBRA
12 - State funded, other
13 - State funded,
unspecified
14 - VA
18 - No health insurance
88 - Other
99 - Unknown
YES_NO_UNK

Transfer
to CDC

Document Source

Required/Optional

YES

All

Optional

YES

All

YYYYMMDD

YES

All

YES_NO_UNK
1 - Provider Report
2 - Patient Interview
3 – Medical Record Review
4 – NHME
5 – Other
YYYYMMDD
YYYYMMDD
YES_NO_UNK

YES
YES

ACRF, PCRF
ACRF

Required if laboratory
tests meet approved
alternative algorithm
Required if laboratory
tests meet approved
alternative algorithm
Required
Required

YES
YES
YES

ACRF
ACRF, PCRF
PCRF

Required
Optional
Retired

TABLE NAME
VARIABLES

231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
OI

DESCRIPTION

eHARS Retired - Did mother receive
zidovudine(ZDV,AZT) during pregnancy
eHARS Retired -If yes, what week of
pregnancy was zidovudine (ZDV, AZT)
start)
eHARS Retired -Did mother receive any
other Antiretroviral medication during
pregnancy?
eHARS Retired -Did mother receive
zidovudine(ZDV,AZT) during
labor/delivery?
eHARS Retired -Did mother receive any
other Antiretroviral medication during
labor/delivery
Did mother receive any ARVs prior to this
pregnancy?
Did mother receive any ARVs during
pregnancy?
Did mother receive any ARVs during
labor/delivery?
Evidence of receipt of HIV medical care
other than laboratory test result

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

YES_NO_REF_UNK

YES

PCRF

Retired

01-52

YES

PCRF

Retired

YES_NO_UNK

YES

PCRF

Retired

YES_NO_REF_UNK

YES

PCRF

Retired

YES_NO_UNK

YES

PCRF

Retired

YES_NO_UNK

YES

PCRF

Optional

YES_NO_UNK

YES

PCRF

Optional

YES_NO_UNK

YES

PCRF

Optional

1 – Yes, documented
2 – Yes, client self-report,
only
YYYYMMDD
YES_NO_UNK
YES_NO_UNK

YES

ACRF

Optional

Date of medical visit or prescription
YES
ACRF
Suspect acute HIV infection
YES
ACRF
Clinical sign/symptom consistent with
YES
ACRF
acute retroviral syndrome
Date of acute retroviral syndrome
YYYYMMDD
YES
ACRF
sign/symptom onset
Other evidence suggestive of acute HIV
YES_NO_UNK
YES
ACRF
infection
Date of other evidence
YYYYMMDD
YES
ACRF
Description of other evidence
[A-Z,0-9, special character]
YES
ACRF
A table that maintains information on a person's opportunistic infections (diseases indicative of AIDS).

Optional
Optional
Optional
Optional
Optional
Optional
Optional

TABLE NAME
VARIABLES

DESCRIPTION

document_uid
dx

A unique identifier for a document.
A code indicating if the diagnosis was
presumptive or definitive.

dx_dt
oi_cd

3-66

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

DEF_PRE

YES
YES

The date the AIDS defining condition was
diagnosed.

YYYYMMDD

YES

A code indicating a person's AIDS defining
conditions.

AD01 - Bacterial infection,
multiple or recurrent
(including Salmonella
septicemia)
AD02 - Candidiasis, bronchi,
trachea, or lungs
AD03 - Candidiasis,
esophageal
AD04 - Carcinoma, invasive
cervical
AD05 - Coccidioidomycosis,
disseminated or
extrapulmonary
AD06 - Cryptococcosis,
extrapulmonary
AD07 - Cryptosporidiosis,
chronic intestinal (>1 mo.
duration)
AD08 - Cytomegalovirus
disease (other than in liver,
spleen, or nodes)
AD09 - Cytomegalovirus
retinitis (with loss of vision)
AD10 - HIV encephalopathy
AD11 - Herpes simplex:
chronic ulcer(s) (>1 mo.
duration) or bronchitis,
pneumonitis, or esophagitis
AD12 - Histoplasmosis,
disseminated or
extrapulmonary

YES

March 13, 2019

Document Source

All
ACRF, PCRF,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LEGACY_ADULT,
LEGACY_PEDIATRIC
ACRF, PCRF,
LEGACY_ADULT,
LEGACY_PEDIATRIC

Required/Optional

System
Optional
Optional
Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
AD13 - Isosporiasis, chronic
intestinal (> 1 mo. duration)
AD14 - Kaposi's sarcoma
AD15 - Lymphoid interstitial
pneumonia and/or
pulmonary lymphoid
AD16 - Lymphoma, Burkitts
(or equivalent term)
AD17 - Lymphoma,
immunoblastic (or
equivalent term)
AD18 - Lymphoma, primary
in brain
AD19 - Mycobacterium
avium complex or M.
kansasii, disseminated or
extrapulmonary
AD20 - M. tuberculosis,
pulmonary
AD21 - M. tuberculosis,
disseminated or
extrapulmonary
AD22 - Mycobacterium, of
other species or
unidentified species,
disseminated or
extrapulmonary
AD23 - Pneumocystis carinii
pneumonia
AD24 - Pneumonia,
recurrent, in 12 mo. period
AD25 - Progressive
multifocal
leukoencephalopathy
AD26 - Salmonella

Transfer
to CDC

Document Source

Required/Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)
septicemia, recurrent
AD27 - Toxoplasmosis of
brain, onset at >1 mo. of
age
AD28 - Wasting syndrome
due to HIV
0-99,999,999

oi_seq

Sequence identifier for a person's AIDS
defining conditions.

PERSON

A table that maintains demographic information about a person.

birth_country_cd

A code indicating the country of birth.

birth_country_usd

Transfer
to CDC

Document Source

Required/Optional

YES

ACRF, PCRF,
LEGACY_ADULT,
LEGACY_PEDIATRIC

System

COUNTRY_CODE (table)

YES

Optional

A code indicating the specific U.S.
dependency of birth.

COUNTRY_CODE (table)

YES

birth_sex

The person's biological sex at birth, as
noted on the birth certificate.

YES

current_gender

The person's current gender or
psychosocial construct that most people
use to classify a person as male, female,
both, or neither. When eHARS is first
installed and configured, the state
determines whether or not this field is
displayed.

YES

All except BC

Optional

current_sex

Physiological anatomy and biology that
determines if someone is male, female, or
intersexed. At installation, the state
determines whether or not this field is
March 13, 2019

F - Female
M - Male
U - Unknown
F - Female
FM - Transgender-Female
to Male
U - Unknown
M - Male
MF - Transgender-Male to
Female
AD - Additional Gender
Identity
F - Female
I - Intersexed
M - Male

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
LEGACY_CONSENT,
LEGACY_TTH
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
LEGACY_CONSENT,
LEGACY_TTH
All

YES

All except BC

Retired

3-68

Optional

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

displayed.
dob
dob_alias

The first known date of birth.
The second known or alias date of birth.

YYYYMMDD
YYYYMMDD

YES
YES

doc_belongs_to

Indicates if the demographics data belong
to PERSON, MOTHER, FATHER, or CHILDn.

PERSON, MOTHER, FATHER,
CHILDn

YES

document_uid
education

A unique identifier for a document.
The level of education (optional field).

ethnicity1

Indicates if the person is of Hispanic or
Latino origin. A person of Cuban, Mexican,
Puerto Rican, South or Central American,
or other Spanish culture or origin,
regardless of race.
Indicates if the person is of Hispanic or
Latino origin. A person of Cuban, Mexican,
Puerto Rican, South or Central American,
or other Spanish culture or origin,

ethnicity2

1 - 8th grade or less
2 - Some high school
3 - High school graduate,
GED or equivalent
4 - Some college
5 - College degree
6 - Post-graduate work
7 - Some school, level
unknown
9 - Unknown
ETHNICITY

ETHNICITY

Required
Optional

YES
NO

All
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
LEGACY_CONSENT,
LEGACY_TTH
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC
All
All except BC

YES

All

Required

YES

All

Optional

System

System
Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

regardless of race.

hars_race

For legacy HARS data, a read-only field
indicating the person's race code entered
in HARS previous to v6.0 (prior to
implementation of Revisions to the
Standards for the Classification of Federal
Data on Race and Ethnicity
[http://www.whitehouse.gov/omb/fedreg
/ombdir15.html]).
HARS expanded race.

1-White, not Hispanic
2-Black, not Hispanic
3-Hispanic
4-Asian/Pacific Islander
5-American Indian/Alaska
Native
9-Unknown

YES

LEGACY_ADULT,
LEGACY_PEDIATRIC

Legacy HARS

HARS_XRACE

YES

LEGACY_ADULT,
LEGACY_PEDIATRIC

Legacy HARS

Is this person a healthcare worker?
(optional field)
Occupation, if healthcare worker (optional
field).

YES_NO_UNK

YES

ACRF

Optional

OCCUPATION

YES

Optional

marital_status

The person's marital status.

NO

race1
race2
race3
race4
race5
vital_status

Indicates the person’s race.
Indicates the person’s race.
Indicates the person’s race.
Indicates the person’s race.
Indicates the person’s race.
Indicates vital status at time form was
completed—alive, dead, or unknown.

A - Married and separated
D - Divorced
M - Married
N - Not otherwise specified
O - Other
S - Single and never married
U - Unknown
W - Widowed
RACE
RACE
RACE
RACE
RACE
1 - Alive
2 - Dead
9 - Unknown

ACRF,
LEGACY_CONSENT,
LEGACY_TTH
All except PCRF

All
All
All
All
All
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC

Required
Required
Required
Required
Required
Required

hars_xrace
hcw
hcw_occup

3-70

March 13, 2019

YES
YES
YES
YES
YES
YES

Optional

TABLE NAME
VARIABLES

PERSON_NAME
doc_belongs_to

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

All

System

document_uid

A table that maintains information on a person’s names and Soundex codes.
Indicates if the name belongs to PERSON,
PERSON, MOTHER, CHILDn
YES
MOTHER, or CHILDn.
A unique identifier for a document.
YES

All

System

first_name

The person's first name.

NO

All

Optional

first_name_sndx

NO

All

System

NO

All

Required

YES

All

System

middle_name

The person's first name in a Soundex
format.
The person's last name. For hyphenated or
last names containing two words, the
standard is as follows: Smith Jones.
The person's last name in a Soundex
format.
The person's middle name.

NO

All

Optional

name_prefix

The person's name prefix.

NO

All

Optional

name_suffix

The person's name suffix.

NO

All

Optional

name_use_cd

A code indicating the type of name being
used, such as Maiden or Birth. The default
value is Legal.
Sequence identifiers for a person's name.

NAME_USE

YES

All

Optional

0-999,999,999

YES

All

System

last_name
last_name_sndx

person_name_seq
removal_ind
PHER_ANTIRETROVIRAL
document_uid
pher_arv_seq
pher_question_uid

A field used by the application to
YES_NO
NO
determine if the name removal utility has
been applied to this row.
A table that maintains information on a mother or child's prescribed antiretroviral.
A unique identifier for an eHARS
[site code] + [number] + [-]
YES
document.
+ [check digit]
Sequence identifier for each antiretroviral -2^31 (-2,147,483,648) to
YES
drug entered
2^31-1 (2,147,483,647)
Unique identifier for each PHER form
PHER_QUESTION (table)
YES

System

PCRF

System

PCRF

System

PCRF

System

TABLE NAME
VARIABLES

drug_cd
other_specify
drug_refused
receive_dt
receive_tm
type_of_administration
drug_start_dt
drug_start_gestational_
age
art_completed
drug_stopped
drug_stop_dt
drug_start_tm
drug_stop_cd_1

3-72

DESCRIPTION

question.
Identifier for antiretroviral drug
Text entered to identify an antiretroviral
drug not available as a data entry
selection
Indicates if a particular antiretroviral drug
was refused
The date when a particular antiretroviral
drug was received
The time when a particular antiretroviral
drug was received
How a particular antiretroviral drug was
administered during the mother’s labor
and delivery
The starting date for a particular
antiretroviral drug
Gestational age when a particular
antiretroviral drug was started
Indicates if antiretroviral therapy was
completed
Indicates a particular antiretroviral drug
was stopped
The date a particular antiretroviral drug
was stopped
Indicates starting time for a particular
antiretroviral drug
Reason(s) for stopping antiretroviral drug

March 13, 2019

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

DRUG

YES
YES

PCRF
PCRF

Required
Required

YES_NO

YES

PCRF

Required

YYYYMMDD

YES

PCRF

Required

HH:MM:SS

YES

PCRF

Required

ORAL_IV_ND

YES

PCRF

Required

YYYYMMDD

YES

PCRF

Required

(01-42) (99=unk) (00=None)

YES

PCRF

Required

YES_NO_ND_UNK

YES

PCRF

Required

YES_NO_ND

YES

PCRF

Required

YYYYMMDD

YES

PCRF

Required

HH:MM:SS

YES

PCRF

Required

S01-Adverse events
(toxicity, lack of tolerance)
S02-ART completed
S03-Drug resistance
detected
S04-Poor adherence
S05-Inadequate
effectiveness
S06-Strategic treatment
interruption (planned drug
holiday)

YES

PCRF

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

drug_stop_cd_2

Reason(s) for stopping antiretroviral drug

S07-Drug interactions
S08-Mother's choice
S09-Pregnancy
S10-Child determined not
to be HIV infected
S11-Improving
effectiveness
S12-Improving convenience
S13-Reason not indicated;
unknown
S14-Mother couldn't afford
drugs
S15-Other reason
STOP_CODES

drug_stop_cd_3

Reason(s) for stopping antiretroviral drug

STOP_CODES

YES

PCRF

Required

drug_stop_cd_4

Reason(s) for stopping antiretroviral drug

STOP_CODES

YES

PCRF

Required

YES

PCRF

System

YES

PCRF

YES

PCRF

YES
YES
YES

PCRF
PCRF
PCRF

Refer to
PHER_QUESTION table
for requirements for
each variable
Refer to
PHER_QUESTION table
for valid data element
values for each variable
Required
Required
Required

NO

PCRF

Optional

YES

PCRF

Required

PHER_OBSERVATION
document_uid
pher_obs_uid

An internal unique identifier for an eHARS
document.
Unique identifier for a PHER observation

pher_obs_value

Response entered in a PHER observation

pher_dt
pher_tm
other_specify

Date entered in a PHER observation
Time entered in a PHER observation
Unlisted records abstracted, substances,
cesarean delivery responses
Additional text entered as comments or

comments

PHER_OBSERVATION_CODE
(table)

YYYYMMDD
HH:MM:SS

TABLE NAME
VARIABLES

PHER_QUESTION
Q01
Q02
Q03

DESCRIPTION

If information on the mother is not
available, was the child adopted, or in
foster care?
Records abstracted.

Q06
Q07

Complete the chart for all siblings.

Q08

Was substance use during pregnancy
noted in the medical or social work
records?
If yes, indicate which substances were
used during pregnancy. (Check all that
apply.)
If substances used, were any injected?

Q05

Q08a
Q08b
Q09
Q09a
Q10

3-74

Transfer
to CDC

Document Source

Required/Optional

clinical information on the PHER tab of the
PCRF

Weeks' gestation at first prenatal care
visit.
Was the mother screened for any of the
following during pregnancy? (Check test
performed before birth, but closest to
date of delivery or admission to labor and
delivery.)
Diagnosis (for the mother) of the following
conditions during this pregnancy or at the
time of labor and delivery.
Mother's reproductive history.

Q04

Valid data element values
(lookup type, reference
table, or actual values)

Was a toxicology screen done on the
mother (either during pregnancy or at the
time of delivery)?
If yes, check all that apply.
Was a toxicology screen done on the
infant at birth?
March 13, 2019

Table documentation under
development

YES

PCRF

Optional

Table documentation under
development
Table documentation under
development
Table documentation under
development

YES

PCRF

Optional

YES

PCRF

Required

YES

PCRF

Optional

Table documentation under
development

YES

PCRF

Optional

Table documentation under
development
Table documentation under
development
Table documentation under
development

YES

PCRF

Optional

YES

PCRF

Optional

YES

PCRF

Optional

Table documentation under
development

YES

PCRF

Optional

Table documentation under
development
Table documentation under
development

YES

PCRF

Optional

YES

PCRF

Optional

Table documentation under
development
Table documentation under
development

YES

PCRF

Optional

YES

PCRF

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Q10a

If yes, check all that apply.

Q11

Q16a

Was the mother's HIV serostatus noted in
her prenatal care medical records?
Were antiretroviral drugs prescribed for
the mother during this pregnancy?
If no antiretroviral drug was prescribed
during pregnancy, check reason.
Was mother's HIV serostatus noted in her
labor and delivery records?
Did mother receive antiretroviral drugs
during labor and delivery?
If no antiretroviral drug was received
during labor and delivery, check reason.
Was mother referred for HIV care after
delivery?
If yes, indicate first CD4 result or first viral
load after discharge from hospital (up to 6
months after discharge).
CD4 result

Q16b

Viral load

Q17

Birth information.

Q18

Q20a

If Cesarean delivery, mark all the following
indications that apply.
Was mother's HIV serostatus noted on the
child's birth record?
Were antiretroviral drugs prescribed for
the child?
If no antiretroviral drug, indicate reason.

Q21

Please include comments or clinical

Q12
Q12a
Q13
Q14
Q14a
Q15
Q16

Q19
Q20

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development

YES

PCRF

Optional

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Optional

YES

PCRF

Required

Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under
development
Table documentation under

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Optional

YES

PCRF

Required

YES

PCRF

Required

YES

PCRF

Optional

TABLE NAME
VARIABLES

PHER_SIBLING
document_uid
pher_sib_seq

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

information you consider relevant to the
development
overall understanding of child's HIV
exposure or infection status. State the
date and source of information.
Table that contains infant sibling information.
Unique identifier for an eHARS document.
Identifies sequence of siblings added to
-2^31 (-2,147,483,648) to
form
2^31-1 (2,147,483,647)
Indicates these data belong to an infant’s
SIBLnn
sibling
Date of birth of an infant’s sibling
YYYYMMDD
Indicates HIV infection status of an
HIV_SEROSTATUS
infant’s sibling
STATENO of an infant’s sibling
CITYNO of an infant’s sibling
A table that maintains information on a person's pretest questionnaire.

YES
YES

PCRF
PCRF

System
System

YES

PCRF

System

YES
YES

PCRF
PCRF

Optional
Optional

YES
YES

PCRF
PCRF

Optional
Optional

YES

ACRF, LEGACY_TTH

System

YES_NO
UCTS

YES
YES

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Optional
Required

YES_NO_REF

YES

ACRF, LEGACY_TTH

Optional

SITE_CD

YES
NO

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Required
Optional

STATE_CODES_PR
FACILITY_TYPE

YES
YES

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Optional
Optional

YES

ACRF, LEGACY_TTH

Optional

ulstnd

A unique identifier for the person’s
Pretest Questionnaire.
Are you now taking any ARVs?
Main source of testing history
information.
When you first tested positive for HIV, was
the HIV test an anonymous test?
Date of first positive HIV test
Name of facility where first tested positive
for HIV
State where first tested positive for HIV
Type of facility where first tested positive
for HIV
When was the first time you ever got
tested for HIV?
Date of last negative HIV test

YES

ACRF, LEGACY_TTH

Required

ulstngs

Type of facility where last tested negative

YES

ACRF, LEGACY_TTH

Optional

doc_belongs_to
sibling_dob
hiv_sero
sibling_stateno
sibling_cityno
PRETEST_QUESTIONNAI
RE
document_uid
qhrtnw
Ucts
ufposa
ufposd
ufps_site
ufps_state
ufpstyp
uftstd

3-76

March 13, 2019

FACILITY_TYPE

TABLE NAME
VARIABLES

ulstngs_site
ulstngs_state
ungtst
unumtsts
upastp
upnumtsts

uptests
uqintd
ur3_5sp

DESCRIPTION

for HIV
Name of facility where last tested negative
for HIV
State where last tested negative for HIV
Ever had a negative HIV test?
Number of negative HIV tests within 24
months before first positive test
Ever had a positive HIV test result?
For persons who had a previous positive
test (Legacy Pre-test form only): In the
two years before your first positive test,
how many times did you get tested for
HIV?
Have you been tested for HIV before
today?
Date patient reported information
Reason for getting today’s HIV test: If
other reason, describe

ur4e_5sp

Reason for getting the first positive HIV
test: If other reason, describe

ureas3_1

Reason for getting today’s HIV test: Think
you might have been exposed to HIV in
the 6 months before the test
Reason for getting today’s HIV test: Get
tested on a regular basis and it is time to
get tested again
Reason for getting today’s HIV test: Just
checking to make sure you are HIV
negative
Reason for getting today’s HIV test:
Required by insurance, military, court, or
other agency

ureas3_2
ureas3_3
ureas3_4

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

SITE_CD

NO

ACRF, LEGACY_TTH

Optional

STATE_CODES_PR
YES_NO_REF_UNK
0-99

YES
YES
YES

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Optional
Required
Required

YES_NO_REF
0-99

YES
YES

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Required
Legacy Incidence

YES_NO_REF

YES

ACRF, LEGACY_TTH

Optional

YES
YES

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Required
Optional

YES

ACRF, LEGACY_TTH

Optional

YES_NO

YES

ACRF, LEGACY_TTH

Optional

YES_NO

YES

ACRF, LEGACY_TTH

Optional

YES_NO

YES

ACRF, LEGACY_TTH

Optional

YES_NO

YES

ACRF, LEGACY_TTH

Optional

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

ureas3_5

Reason for getting today’s HIV test: Other
reason you want to get tested

urs4e_1

Reason for getting the first positive HIV
YES_NO
YES
test: Thought you might have been
exposed to HIV in the past 6 months
before the test
Reason for getting the first positive HIV
YES_NO
YES
test: Got tested on a regular basis and it
was time to get tested again
Reason for getting the first positive HIV
YES_NO
YES
test: Just checking to make sure you were
HIV negative
HIV test required
YES_NO
YES
Reason for getting the first positive HIV
YES_NO
YES
test: Other reason you wanted to get
tested
A table that maintains information on healthcare providers.
The first name of the healthcare provider.
NO
The last name of the healthcare provider.
NO
The middle name of the healthcare
NO
provider.
The name prefix of the healthcare
NO
provider.
The name suffix of the healthcare
NO
provider.
The phone number of the healthcare
7 or 10 digits
NO
provider.
A unique identifier for a healthcare
NO
provider.
A field used by the application to
NO
determine if the information needs to be
transferred to CDC
A code indicating the type of specialty for
SPECIALTY_CD
YES
this health care provider.
A table that maintains information pertaining to a case's duplicate status review.

urs4e_2
urs4e_3
urs4e_4
urs4e_5
PROVIDER_CODE
first_name
last_name
middle_name
name_prefix
name_suffix
phone
provider_uid
ship_flag
specialty_cd
RIDR

3-78

March 13, 2019

YES_NO

Transfer
to CDC

YES

Document Source

Required/Optional

ACRF, LEGACY_TTH

Optional

ACRF, LEGACY_TTH

Optional

ACRF, LEGACY_TTH

Optional

ACRF, LEGACY_TTH

Optional

ACRF, LEGACY_TTH
ACRF, LEGACY_TTH

Optional
Optional

N/A
N/A
N/A

Optional
Optional
Optional

N/A

Optional

N/A

Optional

N/A

Optional

N/A

System

N/A

System

N/A

Optional

TABLE NAME
VARIABLES

comments
document_uid
duplicate_status
ehars_uid
last_verify_dt
state_cd

DESCRIPTION

Notes or comments pertaining to the
duplicate status information entered for
this person.
A unique identifier of the current
document.
The status of the duplicate review, such as
Pending or Same As.
A unique identifier for the existing case.
The date when the status of the duplicate
review was last verified.
The two character postal code of the state
of the possible duplicate case.

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

NO

ACRF, PCRF

Optional

YES

ACRF, PCRF

System

YES

ACRF, PCRF

YYYYMMDD

YES
YES

ACRF, PCRF
ACRF, PCRF

Required if case
identified as potential
duplicate
System
Optional

STATE_CODES_PR

YES

ACRF, PCRF

1 - Same as
2 - Different than
3 - Pending

stateno

The stateno identifier of the possible
duplicate case.

YES

ACRF, PCRF

verify_by

The person who reviewed the duplicate
status entry.
A table that maintains information on a person's risk factors.
Code that indicates the COPHI
1 - Open, under
investigation status, if applicable.
investigation
2 - Closed, confirmed
COPHI
3 - Closed, investigated, not
confirmed
4 - Closed, not a COPHI
5 – Will not be investigated,
not confirmed
9 - Unknown

YES

ACRF, PCRF

YES

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH _DOC

RISK
cophi_status

Required/Optional

Required if case
identified as potential
duplicate
Required if case
identified as potential
duplicate
Optional

Optional

TABLE NAME
VARIABLES

detail

display

DESCRIPTION

This field captures detailed information
about risk factor—the type of clotting
factor the person had or the occupation, if
occupational exposure.
Note: RISK.detail also stores NIR type
information (1 = user entered [if date
investigation was completed is entered], 2
= system assigned)
A field used by the application for display
purposes.

Valid data element values
(lookup type, reference
table, or actual values)
For R04, R30, R33, R32 =>
CLOTTING_FACTOR
For R13 => OCCUPATION
For R80, R81 => 1 = user
entered [if date
investigation was
completed is entered], 2 =
system assigned
A(adult), P(pediatric),
H(hemophilia)

Transfer
to CDC

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC

Optional

NO

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
All

System

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC

Optional

A unique identifier for a document.

resolution_dt

The date the COPHI investigation was
resolved.

YYYYMMDD

YES

risk_cd

Code indicating a risk factor (such as R03
indicating IDU).

RISK_CD (table)

YES

risk_seq

Sequence identifier for a person's modes
of exposure.

0-99,999,999

YES

risk_value

Code indicating the risk factor value (YYes, N-No, U-Unknown, or 2-CDC
confirmed) or the mother's infection
status (1–9).

March 13, 2019

Required/Optional

YES

document_uid

3-80

Document Source

YES

YES

System

Refer to RISK_CD table
for requirements for
each variable
System

Refer to RISK_CD table
for valid data element
values for each variable

TABLE NAME
VARIABLES

trans_first_dt

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

Document Source

Required/Optional

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC

Required

RISK_CD

If patient received transfusion of
YYYYMMDD
YES
blood/blood components, the first date
the patient received transfusion. Note: For
user entered NIR (No Identified Risk), the
date entered is stored in this field.
If patient received transfusion of
YYYYMMDD
YES
blood/blood components, the last date
the patient received transfusion. Note:
When the system identifies NIR, the
system date is stored in this field.
A table that contains all distinct RISK.risk_cd values and associated descriptions.

R01

Sex with male

YES_NO_UNK_CDC

YES

Required

R02

Sex with female

YES_NO_UNK_CDC

YES

R03

Injected non-prescription drugs

YES_NO_UNK_CDC

YES

R04

Received clotting factor for
hemophilia/coagulation disorder

YES_NO_UNK_CDC

YES

R05

Heterosexual contact with
intravenous/injection drug user

YES_NO_UNK_CDC

YES

ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,

trans_last_dt

Required

Required

Required

Required

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

R06

Heterosexual contact with bisexual male

YES_NO_UNK_CDC

YES

R07

Heterosexual contact with person with
hemophilia/coagulation disorder

YES_NO_UNK_CDC

YES

R08

Heterosexual contact with transfusion
recipient with documented HIV infection

YES_NO_UNK_CDC

YES

R09

Heterosexual contact with transplant
recipient with documented HIV infection

YES_NO_UNK_CDC

YES

R10

Heterosexual contact with person with
AIDS or documented HIV infection, risk
not specified

YES_NO_UNK_CDC

YES

R11

Received transfusion of blood/blood
components (other than clotting factor)

YES_NO_UNK_CDC

YES

R12

Received transplant of tissue/organs or
artificial insemination

YES_NO_UNK_CDC

YES

R13

Worked in a health care or clinical

YES_NO_UNK_CDC

YES

3-82

March 13, 2019

Document Source

LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,

Required/Optional

Required

Required

Required

Required

Required

Required

Required

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

laboratory setting

R14

Sexual contact with male

YES_NO_UNK_CDC

YES

R15

Sexual contact with female

YES_NO_UNK_CDC

YES

R16

Child's biological mother's infection status

For R16 only =>
M_INFECTION_STATUS

YES

R17

Perinatally acquired HIV infection

YES_NO_UNK_CDC

YES

R18

Injected non-prescription drugs

YES_NO_UNK_CDC

YES

R19

Heterosexual contact with
intravenous/injection drug user

YES_NO_UNK_CDC

YES

R20

Heterosexual contact with bisexual male

YES_NO_UNK_CDC

YES

Document Source

LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,

Required/Optional

Required

Required

Required

Required

Required

Required

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

R21

Heterosexual contact with male with
hemophilia/coagulation disorder

YES_NO_UNK_CDC

YES

R22

Heterosexual contact with transfusion
recipient with documented HIV infection

YES_NO_UNK_CDC

YES

R23

Heterosexual contact with transplant
recipient with documented HIV infection

YES_NO_UNK_CDC

YES

R24

Heterosexual contact with male with AIDS
or documented HIV infection, risk not
specified

YES_NO_UNK_CDC

YES

R25

Received transfusion of blood/blood
components (other than clotting factor)

YES_NO_UNK_CDC

YES

R26

Received transplant or tissue/organs or
artificial insemination

YES_NO_UNK_CDC

YES

R27

Injected non-prescription drugs

YES_NO_UNK_CDC

YES

3-84

March 13, 2019

Document Source

LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,

Required/Optional

Required

Required

Required

Required

Required

Required

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

R30

Received clotting factor for
hemophilia/coagulation disorder (LEGACY)

YES_NO_UNK_CDC

YES

R32

Received clotting factor for
hemophilia/coagulation disorder (LEGACY)

YES_NO_UNK_CDC

YES

R33

Received clotting factor for
hemophilia/coagulation disorder

YES_NO_UNK_CDC

YES

R34

Received transfusion of blood/blood
components (other than clotting factor)

YES_NO_UNK_CDC

YES

R35

Received transplant of tissue/organs

YES_NO_UNK_CDC

YES

R40

Adult other documented risk

YES_NO_UNK_CDC

YES

R41

Child other documented risk

YES_NO_UNK_CDC

YES

Document Source

BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,

Required/Optional

Required

Required

Required

Required

Required

Required

Required

TABLE NAME
VARIABLES

DESCRIPTION

Valid data element values
(lookup type, reference
table, or actual values)

Transfer
to CDC

R80

Adult no identified risk

YES_NO_UNK_CDC

YES

R81

Child no identified risk

YES_NO_UNK_CDC

YES

3-86

March 13, 2019

Document Source

BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC
ACRF, PCRF,
LAB_DOC,
LEGACY_ADULT,
LEGACY_PEDIATRIC,
BC, DEATH_DOC

Required/Optional

Required

Required


File Typeapplication/pdf
File TitleColumn Definitions
AuthorCDC User
File Modified2019-03-14
File Created2019-03-14

© 2024 OMB.report | Privacy Policy