An HPXML document is like a tree. It consists of elements that contain a data point or contain other child elements. It all starts with a root element and branches out from there.

This page represents a single element in HPXML. This is the description of the element. For numerical data elements, the units (sq.ft., Btu, etc.) are in square brackets.

Data Type

Indicates what kind of data this element holds (text string, numeric).

Min Occurances

The minimum number of times this element is required. 0 is an optional element. 1 is required.

Max Occurances

The maximum number of times this element can occur. 1 means there can be up to one of these (i.e. one Number of Bedrooms element is allowed). ∞ means there can be many (i.e. the house can have any number of windows).

Min Inclusive

The numeric value of this element has to be greater than or equal to this number.

Max Inclusive

The numeric value of this element has to be less than or equal to this number.

Min Exclusive

The numeric value of this element has to be greater than this number.

Max Exclusive

The numeric value of this element has to be less than or equal to this number.

Pattern

The value of this element must match this regular expression.

This lists the additional attributes of this element and the restrictions on the values of those attributes.

This element's value is required to be in this enumeration list.

This element is member of each of the standard data sets that are checked .

HPXML has been mapped to the following data dictionaries:

• Building Energy Data Exchange Specification (BEDES)
• Real Estate Standards Organization Data Dictionary (RESO)
• Appraisal Institute Residential Green and Energy Efficiency Addendum (AI Green Addendum)

The items listed here are the data elements in the respective data dictionaries that are equivalent to this element in HPXML.

HPXML has two element types: 1.) data elements, and 2.) parent elements that have children. This element is a parent element it's children are listed in the tree view in this box.

If the children are a sequence, then the child elements are required to be in the order specified. Bolded elements are required. Non-bold elements are optional. If the children are a choice, then one and only one of the child elements are allowed.

Pressing the triangle next to an element will open it up and show the children of that element. Clicking on an element name navigates to the page for that element for more details.