1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
# -*- coding: utf-8 -*-
import datetime
import logging
import random
import string
logger = logging.getLogger(__file__)
def ishl7(line):
"""Determines whether a *line* looks like an HL7 message.
This method only does a cursory check and does not fully
validate the message.
:rtype: bool
"""
# Prevent issues if the line is empty
if not line:
return False
msh = line.strip()[:4]
if len(msh) != 4:
return False
return msh[:3] == "MSH" and line.count("\rMSH" + msh[3]) == 0
def isbatch(line):
"""
Batches are wrapped in BHS / BTS or have more than one
message
BHS = batch header segment
BTS = batch trailer segment
"""
return line and (
line.strip()[:3] == "BHS"
or (line.count("MSH") > 1 and line.strip()[:3] != "FHS")
)
def isfile(line):
"""
Files are wrapped in FHS / FTS, or may be a batch
FHS = file header segment
FTS = file trailer segment
"""
return line and (line.strip()[:3] == "FHS" or isbatch(line))
def split_file(hl7file):
"""
Given a file, split out the messages.
Does not do any validation on the message.
Throws away batch and file segments.
"""
rv = []
for line in hl7file.split("\r"):
line = line.strip()
if line[:3] in ["FHS", "BHS", "FTS", "BTS"]:
continue
if line[:3] == "MSH":
newmsg = [line]
rv.append(newmsg)
else:
if len(rv) == 0:
logger.error("Segment received before message header [%s]", line)
continue
rv[-1].append(line)
rv = ["\r".join(msg) for msg in rv]
for i, msg in enumerate(rv):
if not msg[-1] == "\r":
rv[i] = msg + "\r"
return rv
alphanumerics = string.ascii_uppercase + string.digits
def generate_message_control_id():
"""Generate a unique 20 character message id.
See http://www.hl7resources.com/Public/index.html?a55433.htm
"""
d = datetime.datetime.utcnow()
# Strip off the decade, ID only has to be unique for 3 years.
# So now we have a 16 char timestamp.
timestamp = d.strftime("%y%j%H%M%S%f")[1:]
# Add 4 chars of uniqueness
unique = "".join(random.sample(alphanumerics, 4))
return timestamp + unique
def escape(container, field, app_map=None):
"""
See: http://www.hl7standards.com/blog/2006/11/02/hl7-escape-sequences/
To process this correctly, the full set of separators (MSH.1/MSH.2) needs to be known.
Pass through the message. Replace recognised characters with their escaped
version. Return an ascii encoded string.
Functionality:
* Replace separator characters (2.10.4)
* replace application defined characters (2.10.7)
* Replace non-ascii values with hex versions using HL7 conventions.
Incomplete:
* replace highlight characters (2.10.3)
* How to handle the rich text substitutions.
* Merge contiguous hex values
"""
if not field:
return field
esc = str(container.esc)
DEFAULT_MAP = {
container.separators[1]: "F", # 2.10.4
container.separators[2]: "R",
container.separators[3]: "S",
container.separators[4]: "T",
container.esc: "E",
"\r": ".br", # 2.10.6
}
rv = []
for offset, c in enumerate(field):
if app_map and c in app_map:
rv.append(esc + app_map[c] + esc)
elif c in DEFAULT_MAP:
rv.append(esc + DEFAULT_MAP[c] + esc)
elif ord(c) >= 0x20 and ord(c) <= 0x7E:
rv.append(c)
else:
rv.append("%sX%2x%s" % (esc, ord(c), esc))
return "".join(rv)
def unescape(container, field, app_map=None): # noqa: C901
"""
See: http://www.hl7standards.com/blog/2006/11/02/hl7-escape-sequences/
To process this correctly, the full set of separators (MSH.1/MSH.2) needs to be known.
This will convert the identifiable sequences.
If the application provides mapping, these are also used.
Items which cannot be mapped are removed
For example, the App Map count provide N, H, Zxxx values
Chapter 2: Section 2.10
At the moment, this functionality can:
* replace the parsing characters (2.10.4)
* replace highlight characters (2.10.3)
* replace hex characters. (2.10.5)
* replace rich text characters (2.10.6)
* replace application defined characters (2.10.7)
It cannot:
* switch code pages / ISO IR character sets
"""
if not field or field.find(container.esc) == -1:
return field
DEFAULT_MAP = {
"H": "_", # Override using the APP MAP: 2.10.3
"N": "_", # Override using the APP MAP
"F": container.separators[1], # 2.10.4
"R": container.separators[2],
"S": container.separators[3],
"T": container.separators[4],
"E": container.esc,
".br": "\r", # 2.10.6
".sp": "\r",
".fi": "",
".nf": "",
".in": " ",
".ti": " ",
".sk": " ",
".ce": "\r",
}
rv = []
collecting = []
in_seq = False
for offset, c in enumerate(field):
if in_seq:
if c == container.esc:
in_seq = False
value = "".join(collecting)
collecting = []
if not value:
logger.warn(
"Error unescaping value [%s], empty sequence found at %d",
field,
offset,
)
continue
if app_map and value in app_map:
rv.append(app_map[value])
elif value in DEFAULT_MAP:
rv.append(DEFAULT_MAP[value])
elif value.startswith(".") and (
(app_map and value[:3] in app_map) or value[:3] in DEFAULT_MAP
):
# Substitution with a number of repetitions defined (2.10.6)
if app_map and value[:3] in app_map:
ch = app_map[value[:3]]
else:
ch = DEFAULT_MAP[value[:3]]
count = int(value[3:])
rv.append(ch * count)
elif (
value[0] == "C"
): # Convert to new Single Byte character set : 2.10.2
# Two HEX values, first value chooses the character set (ISO-IR), second gives the value
logger.warn(
"Error inline character sets [%s] not implemented, field [%s], offset [%s]",
value,
field,
offset,
)
elif value[0] == "M": # Switch to new Multi Byte character set : 2.10.2
# Three HEX values, first value chooses the character set (ISO-IR), rest give the value
logger.warn(
"Error inline character sets [%s] not implemented, field [%s], offset [%s]",
value,
field,
offset,
)
elif value[0] == "X": # Hex encoded Bytes: 2.10.5
value = value[1:]
try:
for off in range(0, len(value), 2):
rv.append(chr(int(value[off : off + 2], 16)))
except Exception:
logger.exception(
"Error decoding hex value [%s], field [%s], offset [%s]",
value,
field,
offset,
)
else:
logger.exception(
"Error decoding value [%s], field [%s], offset [%s]",
value,
field,
offset,
)
else:
collecting.append(c)
elif c == container.esc:
in_seq = True
else:
rv.append(str(c))
return "".join(rv)
|
