Skip to content

Release 5.0 #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nmerket wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Release 5.0 #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eb44e4c
updating all to 5.0
nmerket Dec 23, 2025
d7cdb19
Latest HPXMLMerged.xsd
Dec 23, 2025
cd25540
Merge branch 'master' of https://github.com/hpxmlwg/hpxml into releas…
shorowit Apr 3, 2026
e8f3626
Merge branch 'require_units_and_value' of https://github.com/hpxmlwg/…
shorowit Apr 3, 2026
c0325a3
Merge branch 'master' of https://github.com/hpxmlwg/hpxml into releas…
shorowit May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/audit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Super-duper audit software v1.0</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/bpi2101.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType>BPI-2101</XMLType>
<XMLGeneratedBy>Noel</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/invalid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Super-duper audit software v1.0</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/upgrade.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Joe</XMLGeneratedBy>
Expand Down
4 changes: 2 additions & 2 deletions guide/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@
# built documents.
#
# The short X.Y version.
version = '4.2' # should match hpxml version
version = '5.0' # should match hpxml version
# The full version, including alpha/beta/rc tags.
release = '4.2'
release = '5.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion guide/source/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The HPXML Working Group can be a valuable resource for program administrators, i
Versioning
==========

The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 4.2.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.
The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 5.0.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.

The minor version number is incremented when the schemas are changed in a manner that is backwards compatible with previous versions that share the same major version. In other words, a document created in a previous version of the schema will also validate against the new schema. Examples of changes that require a minor version change include adding elements, adding enumerations, and changing the annotation in the schema for an element.

Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/idref.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/sameas.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/usecases/example1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2023/09" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hpxmlonline.com/2014/6 ../schemas/HPXML.xsd" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hpxmlonline.com/2014/6 ../schemas/HPXML.xsd" schemaVersion="5.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy/>
Expand Down
8 changes: 4 additions & 4 deletions guide/source/software_developer/versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ Versioning

The HPXML schemas follow the `Semantic Versioning v2.0 <http://semver.org/>`_
specification. The version numbers follow a pattern of :ref:`major-version`.
:ref:`minor-version`. :ref:`patch-version` (i.e. 4.2.0).
:ref:`minor-version`. :ref:`patch-version` (i.e. 5.0.0).

The first element of ``HPXML.xsd`` will indicate the version of the schema via
the ``version`` attribute. Note that when referencing a version, the patch
number is assumed to be zero if it is omitted.

.. code-block:: xml

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09"
targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.2">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2025/12"
targetNamespace="http://hpxmlonline.com/2025/12" elementFormDefault="qualified" version="5.0">

Additionally, starting with version 2.0, the version of the schema used is
required in the ``schemaVersion`` attribute on the root element of every
document.

.. code-block:: xml

<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.2">
<HPXML xmlns="http://hpxmlonline.com/2025/12" schemaVersion="5.0">

.. _major-version:

Expand Down
6 changes: 2 additions & 4 deletions merged_schema/HPXMLMerged.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.2">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2025/12" targetNamespace="http://hpxmlonline.com/2025/12" elementFormDefault="qualified" version="5.0">
<xs:element name="HPXML">
<xs:complexType>
<xs:sequence>
Expand Down Expand Up @@ -7151,9 +7151,7 @@
</xs:complexType>
<xs:simpleType name="schemaVersionType">
<xs:restriction base="xs:string">
<xs:enumeration value="4.0"/>
<xs:enumeration value="4.1"/>
<xs:enumeration value="4.2"/>
<xs:enumeration value="5.0"/>
</xs:restriction>
</xs:simpleType>
<!--Address Information Below-->
Expand Down
2 changes: 1 addition & 1 deletion schemas/HPXML.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.2">
xmlns="http://hpxmlonline.com/2025/12" targetNamespace="http://hpxmlonline.com/2025/12" elementFormDefault="qualified" version="5.0">
<xs:include schemaLocation="HPXMLBaseElements.xsd"/>
<xs:element name="HPXML">
<xs:complexType>
Expand Down
2 changes: 1 addition & 1 deletion schemas/HPXMLBaseElements.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.2">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2025/12" targetNamespace="http://hpxmlonline.com/2025/12" elementFormDefault="qualified" version="5.0">
<xs:include schemaLocation="HPXMLDataTypes.xsd"/>
<xs:element name="XMLTransactionHeaderInformation">
<xs:annotation>
Expand Down
6 changes: 2 additions & 4 deletions schemas/HPXMLDataTypes.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.2">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2025/12" targetNamespace="http://hpxmlonline.com/2025/12" elementFormDefault="qualified" version="5.0">
<xs:simpleType name="DataSource">
<xs:restriction base="xs:string">
<xs:enumeration value="user"/>
Expand Down Expand Up @@ -81,9 +81,7 @@
</xs:complexType>
<xs:simpleType name="schemaVersionType">
<xs:restriction base="xs:string">
<xs:enumeration value="4.0"/>
<xs:enumeration value="4.1"/>
<xs:enumeration value="4.2"/>
<xs:enumeration value="5.0"/>
</xs:restriction>
</xs:simpleType>
<!--Address Information Below-->
Expand Down