Skip to content

Fix Result Tree hierarchy description #78

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

Merged
johnpaulett merged 1 commit into from
Jun 8, 2025
Merged

Fix Result Tree hierarchy description #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,14 @@ which aims to replace `txHL7 <https://txhl7.readthedocs.io/>`_.
Result Tree
-----------

HL7 Messages have a limited number of levels. The top level is a Message.
A Message is comprised of a number of Fields (:py:class:`hl7.Field`).
Fields can repeat (:py:class:`hl7.Repetition`). The content of a field
is either a primitive data type (such as a string) or a composite
data type comprised of one or more Components (:py:class:`hl7.Component`). Components
are in turn comprised of Sub-Components (primitive data types).
HL7 messages have a limited number of levels. The top level is a
:py:class:`hl7.Message`. A message is comprised of a number of
:py:class:`hl7.Segment` objects. Each segment contains a series of
:py:class:`hl7.Field` objects. Fields can repeat (:py:class:`hl7.Repetition`).
The content of a field is either a primitive data type (such as a string)
or a composite data type comprised of one or more
:py:class:`hl7.Component` objects. Components are in turn comprised of
sub-components (primitive data types).

The result of parsing is accessed as a tree using python list conventions:

Expand Down
Loading