def parse_subcomponent(text, name=None, datatype='ST', version=None, validation_level=None):
"""
Parse the given ER7-encoded component and return an instance of
:class:`SubComponent <hl7apy.core.SubComponent>`.
:type text: ``str``
:param text: the ER7-encoded string containing the subcomponent data
:type name: ``str``
:param name: the subcomponent's name (e.g. XPN_2)
:type datatype: ``str``
:param datatype: the datatype of the subcomponent (e.g. ST)
:type version: ``str``
:param version: the HL7 version (e.g. "2.5"), or ``None`` to use the default
(see :func:`set_default_version <hl7apy.set_default_version>`)
:type validation_level: ``int``
:param validation_level: the validation level. Possible values are those defined in
:class:`VALIDATION_LEVEL <hl7apy.consts.VALIDATION_LEVEL>` class or ``None`` to use the default
validation level (see :func:`set_default_validation_level <hl7apy.set_default_validation_level>`)
:return: an instance of :class:`SubComponent <hl7apy.core.SubComponent>`
"""
version = _get_version(version)
validation_level = _get_validation_level(validation_level)
return SubComponent(name=name, datatype=datatype, value=text, version=version,
validation_level=validation_level)
def test_highlights(self):
"""
It tests the highlighting functionaly
"""
msg = self._create_test_message(self.msh_values_standard)
value = ST('HIGHLIGHTEDTEXTIMPORTANT', highlights=((0,11), (15,24)))
s = SubComponent(datatype='ST', value=value)
c = Component(datatype='ST')
c.add(s)
msg.msh.msh_8.msh_8_1 = c
self.assertEqual(msg.to_er7(), self.msh_highlighted)
value = ST('HIGHLIGHTEDTEXTIMPORTANT', highlights=((15,24), (0,11)))
s = SubComponent(datatype='ST', value=value)
c = Component(datatype='ST')
c.add(s)
msg.msh.msh_8.msh_8_1 = c
self.assertEqual(msg.to_er7(), self.msh_highlighted)
def test_assign_value_quiet(self):
cmp_str = 'xxx'
c = SubComponent('CWE_1')
c.value = cmp_str
parsed_cmp = parse_component(cmp_str, 'CWE_1')
self.assertEqual(c.to_er7(), parsed_cmp.to_er7())
c = SubComponent('CWE_1') # more child than allowed
c.value = '1&2'
for dt in ('ST', 'ID', 'FT', 'GTS', 'IS', 'TX'):
c = SubComponent(datatype=dt) # max length reached string type
c.value = 65537*'a'
for dt in ('NM', 'SI'):
c = SubComponent(datatype=dt)
c.value = 65537*'1'
def test_wrong_datatype_subcomponent(self):
"""
Tests that if a component is not of the correct datatype the message is not validated
The message used has the CWE_1 of type NM
"""
msg = self._create_message(self.rsp_k21)
cwe_1 = SubComponent('CWE_1', datatype='NM', value='1')
msg.pid.pid_3.cx_10.cwe_1 = cwe_1
self.assertRaises(ValidationError, msg.validate, report_file=self.report_file)
self._test_report_file('ERROR')
def test_wrong_subcomponent(self):
"""
Tests that if there is an unexpected subcomponent the message in not validated
The message used has an unexpected unknown subcomponent in the cx_10
"""
msg = self._create_message(self.rsp_k21)
unkn_subcomponent = SubComponent(datatype='ST')
msg.rsp_k21_query_response.pid.pid_3.cx_10 = Component('CX_10')
msg.rsp_k21_query_response.pid.pid_3.cx_10.add(unkn_subcomponent)
self.assertRaises(ValidationError, msg.validate, report_file=self.report_file)
self._test_report_file('ERROR')
def test_wrong_datatype_component(self):
"""
Tests that if a component is not of the correct datatype the message is not validate
The message used has the MSG_1 of type ST
"""
msg = self._create_message(self.rsp_k21)
msg_1 = Component('MSG_1', datatype='ST')
msg_1.add(SubComponent(datatype='ST', value='ADT_A01'))
msg.msh.msh_9.msg_1 = msg_1
self.assertRaises(ValidationError, msg.validate, report_file=self.report_file)
self._test_report_file('ERROR')
def test_assign_value_strict(self):
cmp_str = 'xxx'
c = SubComponent('CWE_1', validation_level=VALIDATION_LEVEL.STRICT)
c.value = cmp_str
parsed_cmp = parse_component(cmp_str, 'CWE_1')
self.assertEqual(c.to_er7(), parsed_cmp.to_er7())
with self.assertRaises(MaxLengthReached):
for dt in ('ST', 'ID', 'FT', 'GTS', 'IS', 'TX'):
c = SubComponent(datatype=dt, validation_level=VALIDATION_LEVEL.STRICT) # max length reached string type
c.value = 65537*'a'
for dt in ('NM', 'SI'):
c = SubComponent(datatype=dt, validation_level=VALIDATION_LEVEL.STRICT)
c.value = int(65537*'1')
def parse_field(text, name=None, version=None, encoding_chars=None, validation_level=None,
reference=None, force_varies=False):
"""
Parse the given ER7-encoded field and return an instance of :class:`Field <hl7apy.core.Field>`.
:type text: ``str``
:param text: the ER7-encoded string containing the fields to be parsed
:type name: ``str``
:param name: the field name (e.g. MSH_7)
:type version: ``str``
:param version: the HL7 version (e.g. "2.5"), or ``None`` to use the default
(see :func:`set_default_version <hl7apy.set_default_version>`)
:type encoding_chars: ``dict``
:param encoding_chars: a dictionary containing the encoding chars or None to use the default
(see :func:`set_default_encoding_chars <hl7apy.set_default_encoding_chars>`)
:type validation_level: ``int``
:param validation_level: the validation level. Possible values are those defined in
:class:`VALIDATION_LEVEL <hl7apy.consts.VALIDATION_LEVEL>` class or ``None`` to use the default
validation level (see :func:`set_default_validation_level <hl7apy.set_default_validation_level>`)
:type reference: ``dict``
:param reference: a dictionary containing the element structure returned by
:func:`load_reference <hl7apy.load_reference>` or :func:`find_reference <hl7apy.find_reference>`
or belonging to a message profile
:type force_varies: ``boolean``
:param force_varies: flag that force the fields to use a varies structure when no reference is found.
It is used when a segment ends with a field of type varies that thus support infinite children
:return: an instance of :class:`Field <hl7apy.core.Field>`
>>> field = "NUCLEAR^NELDA^W"
>>> nk1_2 = parse_field(field, name="NK1_2")
>>> print(nk1_2)
<Field NK1_2 (NAME) of type XPN>
>>> print(nk1_2.to_er7())
NUCLEAR^NELDA^W
>>> unknown = parse_field(field)
>>> print(unknown)
<Field of type None>
>>> print(unknown.to_er7())
NUCLEAR^NELDA^W
"""
version = _get_version(version)
encoding_chars = _get_encoding_chars(encoding_chars)
validation_level = _get_validation_level(validation_level)
try:
field = Field(name, version=version, validation_level=validation_level, reference=reference)
except InvalidName:
if force_varies:
reference = ('leaf', 'varies', None, None)
field = Field(name, version=version, validation_level=validation_level, reference=reference)
else:
field = Field(version=version, validation_level=validation_level, reference=reference)
if name in ('MSH_1', 'MSH_2'):
s = SubComponent(datatype='ST', value=text, validation_level=validation_level, version=version)
c = Component(datatype='ST', validation_level=validation_level, version=version)
c.add(s)
field.add(c)
else:
children = parse_components(text, field.datatype, version, encoding_chars, validation_level,
field.structure_by_name)
if Validator.is_tolerant(validation_level) and is_base_datatype(field.datatype, version) and \
len(children) > 1:
field.datatype = None
field.children = children
return field
def test_assign_not_allowed_datatype_to_subcomponent(self):
a = SubComponent('HD_1')
with self.assertRaises(OperationNotAllowed):
a.datatype = 'CX'
def test_change_datatype_subcomponent_strict(self):
s = SubComponent (datatype='ST', validation_level=VALIDATION_LEVEL.STRICT)
with self.assertRaises(OperationNotAllowed):
s.datatype = 'TX'
def test_change_datatype_for_valued_subcomponent(self):
a = SubComponent('HD_1', value='value')
with self.assertRaises(OperationNotAllowed):
a.datatype = 'ST'