Skip to content

Commit b0557a8

Browse files
committed
📝 Adds some documentation on "dump" namespace
1 parent 692223e commit b0557a8

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,46 @@ pass in the delimiters for the message.
116116
user> (parser/pr-segment my-delimiters pid-segment)
117117
"PID|||20301||Durden^Tyler^^^Mr.||19700312|M|||..."
118118

119+
### Dump a Message
120+
121+
Lastly we provide tools for displaying more detailed information about the
122+
structure and content of a parsed message. Provide a parsed message to the
123+
`dump` function to get detail on the segments and their data.
124+
125+
```
126+
Delimiters:
127+
Field: |
128+
Component: ^
129+
Repeating: ~
130+
Escape: \
131+
Subcomponent: &
132+
133+
Segment ID: MSH
134+
Index HL7 Index Type Content
135+
----- --------- ----------- -----------
136+
- 1 Atom "|"
137+
0 2 Atom "^~\&"
138+
1 3 Atom "AcmeHIS"
139+
2 4 Atom "StJohn"
140+
3 5 Atom "CATH"
141+
4 6 Atom "StJohn"
142+
5 7 Atom "20061019172719"
143+
7 9 Component 1: "ORM", 2: "O01"
144+
8 10 Atom "1676926150678"
145+
9 11 Atom "P"
146+
10 12 Atom "2.3"
147+
148+
Segment ID: PID
149+
Index HL7 Index Type Content
150+
----- --------- ----------- -----------
151+
2 3 Atom "20301"
152+
4 5 Component 1: "Durden", 2: "Tyler", 3: "", 4: "", 5: "Mr."
153+
6 7 Atom "19700312"
154+
7 8 Atom "M"
155+
10 11 Component 1: "88 Punchward Dr.", 2: "", 3: "Los Angeles", 4: "CA", 5: "11221", 6: "USA"
156+
...
157+
```
158+
119159
Development
120160
------------
121161

0 commit comments

Comments
 (0)