Module Gnumed.exporters.gmPatientExporter

GNUmed simple ASCII EMR export tool.

TODO: - output modes: - HTML - post-0.1 !

Expand source code
"""GNUmed simple ASCII EMR export tool.

TODO:
- output modes:
  - HTML - post-0.1 !
"""
#============================================================
__author__ = "Carlos Moro, Karsten Hilbert"
__license__ = 'GPL v2 or later'

import os.path
import sys
import time
import logging
import shutil


if __name__ == '__main__':
        sys.path.insert(0, '../../')
        from Gnumed.pycommon import gmI18N
        gmI18N.activate_locale()
        gmI18N.install_domain()

from Gnumed.pycommon import gmExceptions
from Gnumed.pycommon import gmPG2
from Gnumed.pycommon import gmTools
from Gnumed.pycommon import gmDateTime

from Gnumed.business import gmAllergy
from Gnumed.business import gmSoapDefs


_log = logging.getLogger('gm.export')
#============================================================
class cEmrExport:

    #--------------------------------------------------------
    def __init__(self, constraints = None, fileout = None, patient = None):
        """
        Constructs a new instance of exporter

        constraints - Exporter constraints for filtering clinical items
        fileout - File-like object as target for dumping operations
        """
        if constraints is None:
            # default constraints to None for complete emr dump
            self.__constraints = {
                'since': None,
                'until': None,
                'encounters': None,
                'episodes': None,
                'issues': None
            }
        else:
            self.__constraints = constraints
        self.__target = fileout
        self.__patient = patient
        self.lab_new_encounter = True
        self.__filtered_items = []
    #--------------------------------------------------------
    def set_constraints(self, constraints = None):
        """Sets exporter constraints.

        constraints - Exporter constraints for filtering clinical items
        """
        if constraints is None:
            # default constraints to None for complete emr dump
            self.__constraints = {
                'since': None,
                'until': None,
                'encounters': None,
                'episodes': None,
                'issues': None
            }
        else:
            self.__constraints = constraints
        return True
    #--------------------------------------------------------
    def get_constraints(self):
        """
        Retrieve exporter constraints
        """
        return self.__constraints
    #--------------------------------------------------------
    def set_patient(self, patient=None):
        """
            Sets exporter patient

            patient - Patient whose data are to be dumped
        """
        if patient is None:
            _log.error("can't set None patient for exporter")
            return
        self.__patient = patient
    #--------------------------------------------------------
    def set_output_file(self, target=None):
        """
            Sets exporter output file
            
            @param file_name - The file to dump the EMR to
            @type file_name - FileType
        """
        self.__target = target
    #--------------------------------------------------------
    def get_patient(self):
        """
            Retrieves patient whose data are to be dumped
        """
        return self.__patient
    #--------------------------------------------------------
    def cleanup(self):
        """
            Exporter class cleanup code
        """
        pass
    #--------------------------------------------------------
    def __dump_vacc_table(self, vacc_regimes):
        """
        Retrieves string containing ASCII vaccination table
        """
        emr = self.__patient.emr
        # patient dob
        patient_dob = self.__patient['dob']
        date_length = len(gmDateTime.pydt_strftime(patient_dob, '%Y %b %d')) + 2

        # dictionary of pairs indication : scheduled vaccination
        vaccinations4regimes = {}
        for a_vacc_regime in vacc_regimes:
            indication = a_vacc_regime['indication']
            vaccinations4regimes[indication] = emr.get_scheduled_vaccinations(indications=[indication])
        # vaccination regimes count
        chart_columns = len(vacc_regimes)
        # foot headers
        foot_headers = ['last booster', 'next booster']           
        # string for both: ending of vaccinations; non boosters needed
        ending_str = '='

        # chart row count, columns width and vaccination dictionary of pairs indication : given shot
        column_widths = []
        chart_rows = -1
        vaccinations = {}
        temp = -1
        for foot_header in foot_headers: # first column width
            if len(foot_header) > temp:
                temp = len(foot_header)
        column_widths.append(temp)          
        for a_vacc_regime in vacc_regimes:
            if a_vacc_regime['shots'] > chart_rows: # max_seq  -> row count 
                chart_rows = a_vacc_regime['shots']
            if (len(a_vacc_regime['l10n_indication'])) > date_length: # l10n indication -> column width
                column_widths.append(len(a_vacc_regime['l10n_indication'])) 
            else:
                column_widths.append(date_length)  # date -> column width at least
            vaccinations[a_vacc_regime['indication']] = emr.get_vaccinations(indications=[a_vacc_regime['indication']]) # given shots 4 indication

        # patient dob in top of vaccination chart 
        txt = '\nDOB: %s' % (gmDateTime.pydt_strftime(patient_dob, '%Y %b %d')) + '\n'

        # vacc chart table headers
        # top ---- header line
        for column_width in column_widths: 
            txt += column_width * '-' + '-'
        txt += '\n'                   
        # indication names header line
        txt += column_widths[0] * ' ' + '|'
        col_index = 1
        for a_vacc_regime in vacc_regimes:
            txt +=    a_vacc_regime['l10n_indication'] + (column_widths[col_index] - len(a_vacc_regime['l10n_indication'])) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        # bottom ---- header line
        for column_width in column_widths:
            txt += column_width * '-' + '-'
        txt += '\n'           

        # vacc chart data
        due_date = None           
        # previously displayed date list
        prev_displayed_date = [patient_dob]
        for a_regime in vacc_regimes:
            prev_displayed_date.append(patient_dob) # initialice with patient dob (useful for due first shot date calculation)
        # iterate data rows
        for row_index in range(0, chart_rows):              
            row_header = '#%s' %(row_index+1)
            txt += row_header + (column_widths[0] - len(row_header)) * ' ' + '|'

            for col_index in range(1, chart_columns+1):
                indication =vacc_regimes[col_index-1]['indication']
                seq_no = vacc_regimes[col_index-1]['shots']
                if row_index == seq_no: # had just ended scheduled vaccinations
                     txt += ending_str * column_widths[col_index] + '|'
                elif row_index < seq_no: # vaccination scheduled
                    try:
                        vacc_date = vaccinations[indication][row_index]['date'] # vaccination given
                        vacc_date_str = gmDateTime.pydt_strftime(vacc_date, '%Y %b %d')
                        txt +=    vacc_date_str + (column_widths[col_index] - len(vacc_date_str)) * ' ' + '|'
                        prev_displayed_date[col_index] = vacc_date
                    except Exception:
                        if row_index == 0: # due first shot
                            due_date = prev_displayed_date[col_index] + vaccinations4regimes[indication][row_index]['age_due_min'] # FIXME 'age_due_min' not properly retrieved
                        else: # due any other than first shot
                            due_date = prev_displayed_date[col_index] + vaccinations4regimes[indication][row_index]['min_interval']
                        txt += '('+ due_date.strftime('%Y-%m-%d') + ')' + (column_widths[col_index] - date_length) * ' ' + '|'
                        prev_displayed_date[col_index] = due_date
                else: # not scheduled vaccination at that position
                    txt += column_widths[col_index] * ' ' + '|'
            txt += '\n' # end of scheduled vaccination dates display
            for column_width in column_widths: # ------ separator line
                txt += column_width * '-' + '-'
            txt += '\n'

        # scheduled vaccination boosters (date retrieving)
        all_vreg_boosters = []                  
        for a_vacc_regime in vacc_regimes:
            vaccs4indication = vaccinations[a_vacc_regime['indication']] # iterate over vaccinations by indication
            given_boosters = [] # will contain given boosters for current indication
            for a_vacc in vaccs4indication:
                try:
                     if a_vacc['is_booster']:
                         given_boosters.append(a_vacc)
                except Exception:
                    # not a booster
                    pass
            if len(given_boosters) > 0:
                all_vreg_boosters.append(given_boosters[len(given_boosters)-1]) # last of given boosters
            else:
                all_vreg_boosters.append(None)

        # next booster in schedule
        all_next_boosters = []
        for a_booster in all_vreg_boosters:
            all_next_boosters.append(None)
        # scheduled vaccination boosters (displaying string)
        cont = 0
        for a_vacc_regime in vacc_regimes:
            vaccs = vaccinations4regimes[a_vacc_regime['indication']]         
            if vaccs[len(vaccs)-1]['is_booster'] == False: # booster is not scheduled/needed
                all_vreg_boosters[cont] = ending_str * column_widths[cont+1]
                all_next_boosters[cont] = ending_str * column_widths[cont+1]
            else:
                indication = vacc_regimes[cont]['indication']
                if len(vaccinations[indication]) > vacc_regimes[cont]['shots']: # boosters given
                    all_vreg_boosters[cont] = vaccinations[indication][len(vaccinations[indication])-1]['date'].strftime('%Y-%m-%d') # show last given booster date
                    scheduled_booster = vaccinations4regimes[indication][len(vaccinations4regimes[indication])-1]
                    booster_date = vaccinations[indication][len(vaccinations[indication])-1]['date'] + scheduled_booster['min_interval']
                    if booster_date < gmDateTime.pydt_now_here():
                        all_next_boosters[cont] = '<(' + booster_date.strftime('%Y-%m-%d') + ')>' # next booster is due
                    else:
                        all_next_boosters[cont] = booster_date.strftime('%Y-%m-%d')
                elif len(vaccinations[indication]) == vacc_regimes[cont]['shots']: # just finished vaccinations, begin boosters
                    all_vreg_boosters[cont] = column_widths[cont+1] * ' '
                    scheduled_booster = vaccinations4regimes[indication][len(vaccinations4regimes[indication])-1]
                    booster_date = vaccinations[indication][len(vaccinations[indication])-1]['date'] + scheduled_booster['min_interval']
                    if booster_date < gmDateTime.pydt_now_here():
                        all_next_boosters[cont] = '<(' + booster_date.strftime('%Y-%m-%d') + ')>' # next booster is due
                    else:
                        all_next_boosters[cont] = booster_date.strftime('%Y-%m-%d')
                else:
                    all_vreg_boosters[cont] = column_widths[cont+1] * ' '  # unfinished schedule
                    all_next_boosters[cont] = column_widths[cont+1] * ' '
            cont += 1

        # given boosters
        foot_header = foot_headers[0]
        col_index = 0
        txt += foot_header + (column_widths[0] - len(foot_header)) * ' ' + '|'
        col_index += 1
        for a_vacc_regime in vacc_regimes:
            txt +=    str(all_vreg_boosters[col_index-1]) + (column_widths[col_index] - len(str(all_vreg_boosters[col_index-1]))) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        for column_width in column_widths:              
            txt += column_width * '-' + '-'
        txt += '\n' 

        # next booster
        foot_header = foot_headers[1]
        col_index = 0
        txt += foot_header + (column_widths[0] - len(foot_header)) * ' ' + '|'
        col_index += 1
        for a_vacc_regime in vacc_regimes:
            txt +=    str(all_next_boosters[col_index-1]) + (column_widths[col_index] - len(str(all_next_boosters[col_index-1]))) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        for column_width in column_widths:
            txt += column_width * '-' + '-'
        txt += '\n'                   

        self.__target.write(txt)        
    #--------------------------------------------------------
    def get_vacc_table(self):
        """
        Iterate over patient scheduled regimes preparing vacc tables dump
        """           
        
        emr = self.__patient.emr
        
        # vaccination regimes
        all_vacc_regimes = emr.get_scheduled_vaccination_regimes()
        # Configurable: vacc regimes per displayed table
        # FIXME: option, post 0.1 ?
        max_regs_per_table = 4

        # Iterate over patient scheduled regimes dumping in tables of 
        # max_regs_per_table regimes per table
        reg_count = 0
        vacc_regimes = []
        for total_reg_count in range(0,len(all_vacc_regimes)):
            if reg_count%max_regs_per_table == 0:
                if len(vacc_regimes) > 0:
                    self.__dump_vacc_table(vacc_regimes)
                vacc_regimes = []
                reg_count = 0
            vacc_regimes.append(all_vacc_regimes[total_reg_count])
            reg_count += 1
        if len(vacc_regimes) > 0:
            self.__dump_vacc_table(vacc_regimes)        

    #--------------------------------------------------------
    def dump_item_fields(self, offset, item, field_list):
        """
            Dump information related to the fields of a clinical item
            offset - Number of left blank spaces
            item - Item of the field to dump
            fields - Fields to dump
        """
        txt = ''
        for a_field in field_list:
            if type(a_field) is not str:
                a_field = str(a_field, encoding='latin1', errors='replace')
            txt += '%s%s%s' % ((offset * ' '), a_field, gmTools.coalesce(item[a_field], '\n', template4value = ': %s\n'))
        return txt
    #--------------------------------------------------------
    def get_allergy_output(self, allergy, left_margin = 0):
        """
            Dumps allergy item data
            allergy - Allergy item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = ''
        txt += left_margin*' ' + _('Allergy')  + ': \n'
        txt += self.dump_item_fields((left_margin+3), allergy, ['allergene', 'substance', 'generic_specific','l10n_type', 'definite', 'reaction'])
        return txt
    #--------------------------------------------------------
    def get_vaccination_output(self, vaccination, left_margin = 0):
        """
            Dumps vaccination item data
            vaccination - Vaccination item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = ''
        txt += left_margin*' ' + _('Vaccination') + ': \n'
        txt += self.dump_item_fields((left_margin+3), vaccination, ['l10n_indication', 'vaccine', 'batch_no', 'site', 'narrative'])           
        return txt
    #--------------------------------------------------------
    def get_lab_result_output(self, lab_result, left_margin = 0):
        """
            Dumps lab result item data
            lab_request - Lab request item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if self.lab_new_encounter:
            txt += (left_margin)*' ' + _('Lab result') + ': \n'
        txt += (left_margin+3) * ' ' + lab_result['unified_name']  + ': ' + lab_result['unified_val']+ ' ' + lab_result['val_unit'] + ' (' + lab_result['material'] + ')' + '\n'
        return txt
    #--------------------------------------------------------
    def get_item_output(self, item, left_margin = 0):
        """
            Obtains formatted clinical item output dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_output(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_output(item, left_margin)
 #           txt += self.get_lab_result_output(item, left_margin)
  #          self.lab_new_encounter = False
        return txt
    #--------------------------------------------------------
    def __fetch_filtered_items(self):
        """
            Retrieve patient clinical items filtered by multiple constraints
        """
        #if not self.__patient.connected:
        #    return False
        emr = self.__patient.emr
        filtered_items = []
        filtered_items.extend(emr.get_allergies(
            since=self.__constraints['since'],
            until=self.__constraints['until'],
            encounters=self.__constraints['encounters'],
            episodes=self.__constraints['episodes'],
            issues=self.__constraints['issues'])
        )
        self.__filtered_items = filtered_items
        return True
    #--------------------------------------------------------
    def get_allergy_summary(self, allergy, left_margin = 0):
        """
            Dumps allergy item data summary
            allergy - Allergy item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = _('%sAllergy: %s, %s (noted %s)\n') % (
            left_margin * ' ',
            allergy['descriptor'],
            gmTools.coalesce(allergy['reaction'], _('unknown reaction')),
            gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d')
        )
#        txt = left_margin * ' ' \
#           + _('Allergy') + ': ' \
#            + allergy['descriptor'] + u', ' \
#            + gmTools.coalesce(allergy['reaction'], _('unknown reaction')) ' ' \
#            + _('(noted %s)') % gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d') \
#            + '\n'
        return txt
    #--------------------------------------------------------
    def get_vaccination_summary(self, vaccination, left_margin = 0):
        """
            Dumps vaccination item data summary
            vaccination - Vaccination item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = left_margin*' ' + _('Vaccination') + ': ' + vaccination['l10n_indication'] + ', ' + \
            vaccination['narrative'] + '\n'
        return txt
    #--------------------------------------------------------
    def get_lab_result_summary(self, lab_result, left_margin = 0):
        """
            Dumps lab result item data summary
            lab_request - Lab request item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if self.lab_new_encounter:
            txt += (left_margin+3)*' ' + _('Lab') + ': '  + \
                lab_result['unified_name'] + '-> ' + lab_result['unified_val'] + \
                ' ' + lab_result['val_unit']+ '\n' + '(' + lab_result['req_when'].strftime('%Y-%m-%d') + ')'
        return txt
    #--------------------------------------------------------
    def get_item_summary(self, item, left_margin = 0):
        """
            Obtains formatted clinical item summary dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_summary(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_summary(item, left_margin)
#           True: 
 #           #(item['relevant'] == True or item['abnormal'] == True):
  #          txt += self.get_lab_result_summary(item, left_margin)
   #         self.lab_new_encounter = False
        return txt
    #--------------------------------------------------------             
    def refresh_historical_tree(self, emr_tree):
        """
        checks a emr_tree constructed with this.get_historical_tree() 
        and sees if any new items need to be inserted.
        """
        #TODO , caching eliminates tree update time, so don't really need this
        self._traverse_health_issues( emr_tree, self._update_health_issue_branch)
    #--------------------------------------------------------             
    def get_historical_tree( self, emr_tree):
        self._traverse_health_issues( emr_tree, self._add_health_issue_branch)
    #--------------------------------------------------------             
    def _traverse_health_issues(self, emr_tree, health_issue_action):
        """
        Retrieves patient's historical in form of a wx tree of health issues
                                                                                        -> episodes
                                                                                           -> encounters
        Encounter object is associated with item to allow displaying its information
        """
        # variable initialization
        # this protects the emrBrowser from locking up in a paint event, e.g. in
        # some configurations which want to use emrBrowser, but don't stop tabbing
        # to emr browser when no patient selected. the effect is to displace a cNull instance
        # which is a sane representation when no patient is selected.
        if not self.__fetch_filtered_items():
            return
        emr = self.__patient.emr
        unlinked_episodes = emr.get_episodes(issues = [None])
        h_issues = []
        h_issues.extend(emr.get_health_issues(id_list = self.__constraints['issues']))
        # build the tree
        # unlinked episodes
        if len(unlinked_episodes) > 0:
            h_issues.insert(0, {
                'description': _('Unattributed episodes'),
                'pk_health_issue': None
            })
        # existing issues
        for a_health_issue in h_issues:
            health_issue_action( emr_tree, a_health_issue)

        root_item = emr_tree.GetRootItem()
        if len(h_issues) == 0:
            emr_tree.SetItemHasChildren(root_item, False)
        else:
            emr_tree.SetItemHasChildren(root_item, True)
        emr_tree.SortChildren(root_item)
    #--------------------------------------------------------
    def _add_health_issue_branch( self, emr_tree, a_health_issue):
            """appends to a wx emr_tree  , building wx treenodes from the health_issue  make this reusable for non-collapsing tree updates"""
            emr = self.__patient.emr
            root_node = emr_tree.GetRootItem()
            issue_node =  emr_tree.AppendItem(root_node, a_health_issue['description'])
            emr_tree.SetItemData(issue_node, a_health_issue)
            episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])
            if len(episodes) == 0:
                emr_tree.SetItemHasChildren(issue_node, False)
            else:
                emr_tree.SetItemHasChildren(issue_node, True)
            for an_episode in episodes:
                self._add_episode_to_tree( emr, emr_tree, issue_node,a_health_issue,  an_episode)
            emr_tree.SortChildren(issue_node)
    #--------------------------------------------------------
    def _add_episode_to_tree( self, emr , emr_tree, issue_node, a_health_issue, an_episode):
        episode_node =  emr_tree.AppendItem(issue_node, an_episode['description'])
        emr_tree.SetItemData(episode_node, an_episode)
        if an_episode['episode_open']:
            emr_tree.SetItemBold(issue_node, True)

        encounters = self._get_encounters( an_episode, emr )
        if len(encounters) == 0:
            emr_tree.SetItemHasChildren(episode_node, False)
        else:
            emr_tree.SetItemHasChildren(episode_node, True)
        self._add_encounters_to_tree( encounters,  emr_tree, episode_node )
        emr_tree.SortChildren(episode_node)
        return episode_node
    #--------------------------------------------------------
    def _add_encounters_to_tree( self, encounters, emr_tree, episode_node):
        for an_encounter in encounters:
#            label = u'%s: %s' % (an_encounter['started'].strftime('%Y-%m-%d'), an_encounter['l10n_type'])
            label = '%s: %s' % (
                an_encounter['started'].strftime('%Y-%m-%d'),
                                gmTools.unwrap (
                        gmTools.coalesce (
                        gmTools.coalesce (
                            gmTools.coalesce (
                                an_encounter.get_latest_soap (                                          # soAp
                                    soap_cat = 'a',
                                    episode = emr_tree.GetItemData(episode_node)['pk_episode']
                                ),
                                an_encounter['assessment_of_encounter']                         # or AOE
                            ),
                            an_encounter['reason_for_encounter']                                        # or RFE
                        ),
                        an_encounter['l10n_type']                                                                       # or type
                        ),
                        max_length = 40
                )
            )
            encounter_node_id = emr_tree.AppendItem(episode_node, label)
            emr_tree.SetItemData(encounter_node_id, an_encounter)
            emr_tree.SetItemHasChildren(encounter_node_id, False)
    #--------------------------------------------------------
    def _get_encounters ( self, an_episode, emr ):
               encounters = emr.get_encounters (
                   episodes = [an_episode['pk_episode']]
               )
               return encounters
    #--------------------------------------------------------
    def  _update_health_issue_branch(self, emr_tree, a_health_issue):
        emr = self.__patient.emr
        root_node = emr_tree.GetRootItem()
        id, cookie = emr_tree.GetFirstChild(root_node)
        found = False
        while id.IsOk():
            if emr_tree.GetItemText(id)  ==  a_health_issue['description']:
                found = True
                break
            id,cookie = emr_tree.GetNextChild( root_node, cookie)

        if not found:
            _log.error("health issue %s should exist in tree already", a_health_issue['description'] )
            return
        issue_node = id
        episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])

        #check for removed episode and update tree
        tree_episodes = {} 
        id_episode, cookie = emr_tree.GetFirstChild(issue_node)
        while id_episode.IsOk():
            tree_episodes[ emr_tree.GetItemData(id_episode)['pk_episode'] ]= id_episode
            id_episode,cookie = emr_tree.GetNextChild( issue_node, cookie)

        existing_episode_pk = [ e['pk_episode'] for e in episodes]
        missing_tree_pk = [ pk for pk in tree_episodes if pk not in existing_episode_pk]
        for pk in missing_tree_pk:
            emr_tree.Remove( tree_episodes[pk] )

        added_episode_pk = [pk for pk in existing_episode_pk if pk not in tree_episodes]
        add_episodes = [ e for e in episodes if e['pk_episode'] in added_episode_pk]

        #check for added episodes and update tree
        for an_episode in add_episodes:
            node = self._add_episode_to_tree( emr, emr_tree, issue_node, a_health_issue, an_episode)
            tree_episodes[an_episode['pk_episode']] = node

        for an_episode in episodes:
            # found episode, check for encounter change
            try:
                #print "getting id_episode of ", an_episode['pk_episode']
                id_episode = tree_episodes[an_episode['pk_episode']]    
            except Exception:
                import pdb
                pdb.set_trace()
            # get a map of encounters in the tree by pk_encounter as key
            tree_enc = {}
            id_encounter, cookie = emr_tree.GetFirstChild(id_episode)
            while id_encounter.IsOk():
                tree_enc[ emr_tree.GetItemData(id_encounter)['pk_encounter'] ] = id_encounter
                id_encounter,cookie = emr_tree.GetNextChild(id_episode, cookie)

            # remove encounters in tree not in existing encounters in episode
#            encounters = self._get_encounters( a_health_issue, an_episode, emr )
            encounters = self._get_encounters( an_episode, emr )
            existing_enc_pk = [ enc['pk_encounter'] for enc in encounters]
            missing_enc_pk = [ pk  for pk in tree_enc if pk not in existing_enc_pk]
            for pk in missing_enc_pk:
                emr_tree.Remove( tree_enc[pk] )

            # check for added encounter
            added_enc_pk = [ pk for pk in existing_enc_pk if pk not in tree_enc ]
            add_encounters = [ enc for enc in encounters if enc['pk_encounter'] in added_enc_pk]
            if add_encounters != []:
                #print "DEBUG found encounters to add"
                self._add_encounters_to_tree( add_encounters, emr_tree, id_episode)
    #--------------------------------------------------------
    def get_summary_info(self, left_margin = 0):
        """
        Dumps patient EMR summary
        """
        txt = ''
        for an_item in self.__filtered_items:
            txt += self.get_item_summary(an_item, left_margin)
        return txt
    #--------------------------------------------------------
    def get_episode_summary (self, episode, left_margin = 0):
        """Dumps episode specific data"""
        emr = self.__patient.emr
        encs = emr.get_encounters(episodes = [episode['pk_episode']])
        if encs is None:
            txt = left_margin * ' ' + _('Error retrieving encounters for episode\n%s') % str(episode)
            return txt
        no_encs = len(encs)
        if no_encs == 0:
            txt = left_margin * ' ' + _('There are no encounters for this episode.')
            return txt
        if episode['episode_open']:
            status = _('active')
        else:
            status = _('finished')
        first_encounter = emr.get_first_encounter(episode_id = episode['pk_episode'])
        last_encounter = emr.get_last_encounter(episode_id = episode['pk_episode'])
        txt = _(
            '%sEpisode "%s" [%s]\n'
            '%sEncounters: %s (%s - %s)\n'
            '%sLast worked on: %s\n'
        ) % (
            left_margin * ' ', episode['description'], status,
            left_margin * ' ', no_encs, first_encounter['started'].strftime('%m/%Y'), last_encounter['last_affirmed'].strftime('%m/%Y'),
            left_margin * ' ', last_encounter['last_affirmed'].strftime('%Y-%m-%d %H:%M')
        )
        return txt
    #--------------------------------------------------------
    def get_encounter_info(self, episode, encounter, left_margin = 0):
        """
        Dumps encounter specific data (rfe, aoe and soap)
        """
        emr = self.__patient.emr
        # general
        txt = (' ' * left_margin) + '#%s: %s - %s   %s' % (
            encounter['pk_encounter'],
            encounter['started'].strftime('%Y-%m-%d %H:%M'),
            encounter['last_affirmed'].strftime('%H:%M (%Z)'),
            encounter['l10n_type']
        )
        if (encounter['assessment_of_encounter'] is not None) and (len(encounter['assessment_of_encounter']) > 0):
            txt += ' "%s"' % encounter['assessment_of_encounter']
        txt += '\n\n'

        # rfe/aoe
        txt += (' ' * left_margin) + '%s: %s\n' % (_('RFE'), encounter['reason_for_encounter'])
        txt += (' ' * left_margin) + '%s: %s\n' % (_('AOE'), encounter['assessment_of_encounter'])

        # soap
        soap_cat_labels = {
            's': _('Subjective'),
            'o': _('Objective'),
            'a': _('Assessment'),
            'p': _('Plan'),
            'u': _('Unspecified'),
            None: _('Administrative')
        }
        eol_w_margin = '\n' + (' ' * (left_margin+3))
        for soap_cat in 'soapu':
            soap_cat_narratives = emr.get_clin_narrative (
                episodes = [episode['pk_episode']],
                encounters = [encounter['pk_encounter']],
                soap_cats = [soap_cat]
            )
            if soap_cat_narratives is None:
                continue
            if len(soap_cat_narratives) == 0:
                continue
            txt += (' ' * left_margin) + soap_cat_labels[soap_cat] + ':\n'
            for soap_entry in soap_cat_narratives:
                txt += gmTools.wrap (
                    '%s %.8s: %s\n' % (
                        soap_entry['date'].strftime('%d.%m. %H:%M'),
                        soap_entry['modified_by'],
                        soap_entry['narrative']
                    ), 75
                )

#                txt += (
 #                   (' ' * (left_margin+3)) +
  #                  soap_entry['date'].strftime('%H:%M %.8s: ') % soap_entry['modified_by'] +
   #                 soap_entry['narrative'].replace('\n', eol_w_margin) +
    #                '\n'
     #           )
                #FIXME: add diagnoses

        # items
        for an_item in self.__filtered_items:
            if an_item['pk_encounter'] == encounter['pk_encounter']:
                txt += self.get_item_output(an_item, left_margin)
        return txt

    #--------------------------------------------------------  
    def dump_historical_tree(self):
        """Dumps patient's historical in form of a tree of health issues
                                                        -> episodes
                                                           -> encounters
                                                              -> clinical items
        """

        # fecth all values
        self.__fetch_filtered_items()
        emr = self.__patient.emr

        # dump clinically relevant items summary
        for an_item in self.__filtered_items:
            self.__target.write(self.get_item_summary(an_item, 3))
                
        # begin with the tree
        h_issues = []
        h_issues.extend(emr.get_health_issues(id_list = self.__constraints['issues']))
        # unlinked episodes
        unlinked_episodes = emr.get_episodes(issues = [None])
        if len(unlinked_episodes) > 0:
            h_issues.insert(0, {'description':_('Unattributed episodes'), 'pk_health_issue':None})        
        for a_health_issue in h_issues:
            self.__target.write('\n' + 3*' ' + 'Health Issue: ' + a_health_issue['description'] + '\n')
            episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])
            for an_episode in episodes:
               self.__target.write('\n' + 6*' ' + 'Episode: ' + an_episode['description'] + '\n')
               if a_health_issue['pk_health_issue'] is None:
                  issues = None
               else:
                  issues = [a_health_issue['pk_health_issue']]
               encounters = emr.get_encounters (
                  since = self.__constraints['since'],
                  until = self.__constraints['until'],
                  id_list = self.__constraints['encounters'],
                  episodes = [an_episode['pk_episode']],
                  issues = issues
               )
               for an_encounter in encounters:
                    # title
                    self.lab_new_encounter = True
                    self.__target.write(
                        '\n            %s %s: %s - %s (%s)\n' % (
                            _('Encounter'),
                            an_encounter['l10n_type'],
                            an_encounter['started'].strftime('%A, %Y-%m-%d %H:%M'),
                            an_encounter['last_affirmed'].strftime('%m-%d %H:%M'),
                            an_encounter['assessment_of_encounter']
                        )
                    )
                    self.__target.write(self.get_encounter_info(an_episode, an_encounter, 12))
    #--------------------------------------------------------
    def dump_clinical_record(self):
        """
        Dumps in ASCII format patient's clinical record
        """
        emr = self.__patient.emr
        if emr is None:
            _log.error('cannot get EMR text dump')
            print((_(
                'An error occurred while retrieving a text\n'
                'dump of the EMR for the active patient.\n\n'
                'Please check the log file for details.'
            )))
            return None
        self.__target.write('\nOverview\n')
        self.__target.write('--------\n')
        self.__target.write("1) Allergy status (for details, see below):\n\n")
        for allergy in       emr.get_allergies():
            self.__target.write("    " + allergy['descriptor'] + "\n\n")
        self.__target.write("2) Vaccination status (* indicates booster):\n")
#        self.get_vacc_table()
        self.__target.write("\n3) Historical:\n\n")
        self.dump_historical_tree()

        try:
            emr.cleanup()
        except Exception:
            print("error cleaning up EMR")
    #--------------------------------------------------------
    def dump_med_docs(self):
        """
            Dumps patient stored medical documents

        """
        doc_folder = self.__patient.get_document_folder()

        self.__target.write('\n4) Medical documents: (date) reference - type "comment"\n')
        self.__target.write('                          object - comment')

        docs = doc_folder.get_documents()
        for doc in docs:
            self.__target.write('\n\n    (%s) %s - %s "%s"' % (
                doc['clin_when'].strftime('%Y-%m-%d'),
                doc['ext_ref'],
                doc['l10n_type'],
                doc['comment'])
            )
            for part in doc.parts:
                self.__target.write('\n         %s - %s' % (
                    part['seq_idx'],
                    part['obj_comment'])
                )
        self.__target.write('\n\n')
    #--------------------------------------------------------     
    def dump_demographic_record(self, all = False):
        """
            Dumps in ASCII format some basic patient's demographic data
        """
        if self.__patient is None:
            _log.error('cannot get Demographic export')
            print((_(
                'An error occurred while Demographic record export\n'
                'Please check the log file for details.'
            )))
            return None

        self.__target.write('\n\n\nDemographics')
        self.__target.write('\n------------\n')
        self.__target.write('    Id: %s \n' % self.__patient['pk_identity'])
        cont = 0
        for name in self.__patient.get_names():
            if cont == 0:
                self.__target.write('    Name (Active): %s, %s\n' % (name['firstnames'], name['lastnames']) )
            else:
                self.__target.write('    Name %s: %s, %s\n' % (cont, name['firstnames'], name['lastnames']))
            cont += 1
        self.__target.write('    Gender: %s\n' % self.__patient['gender'])
        self.__target.write('    Title: %s\n' % self.__patient['title'])
        self.__target.write('    Dob: %s\n' % self.__patient.get_formatted_dob(format = '%Y-%m-%d'))
        self.__target.write('    Medical age: %s\n' % self.__patient.get_medical_age())
    #--------------------------------------------------------
    def dump_constraints(self):
        """
            Dumps exporter filtering constraints
        """
        self.__first_constraint = True
        if not self.__constraints['since'] is None:
            self.dump_constraints_header()
            self.__target.write('\nSince: %s' % self.__constraints['since'].strftime('%Y-%m-%d'))

        if not self.__constraints['until'] is None:
            self.dump_constraints_header()
            self.__target.write('\nUntil: %s' % self.__constraints['until'].strftime('%Y-%m-%d'))

        if not self.__constraints['encounters'] is None:
            self.dump_constraints_header()
            self.__target.write('\nEncounters: ')
            for enc in self.__constraints['encounters']:
                self.__target.write(str(enc) + ' ')

        if not self.__constraints['episodes'] is None:
            self.dump_constraints_header()
            self.__target.write('\nEpisodes: ')
            for epi in self.__constraints['episodes']:
                self.__target.write(str(epi) + ' ')

        if not self.__constraints['issues'] is None:
            self.dump_constraints_header()
            self.__target.write('\nIssues: ')
            for iss in self.__constraints['issues']:
                self.__target.write(str(iss) + ' ')
    #--------------------------------------------------------
    def dump_constraints_header(self):
        """
            Dumps constraints header
        """
        if self.__first_constraint == True:
            self.__target.write('\nClinical items dump constraints\n')
            self.__target.write('-'*(len(head_txt)-2))
            self.__first_constraint = False

#============================================================
class cEMRJournalExporter:
        """Exports patient EMR into a simple chronological journal.
        """
        def __init__(self):
                self.__narrative_wrap_len = 72

        #--------------------------------------------------------
        # external API
        #--------------------------------------------------------
        def save_to_file_by_mod_time(self, filename=None, patient=None):
                if patient is None:
                        raise ValueError('[%s].save_to_file_by_mod_time(): no patient' % self.__class__.__name__)

                if filename is None:
                        filename = gmTools.get_unique_filename(prefix = 'gm-emr_by_mod_time-', suffix = '.txt')

                f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')

                self.__narrative_wrap_len = 80

                # write header
                txt = _('EMR Journal sorted by last modification time\n')
                f.write(txt)
                f.write('=' * (len(txt)-1))
                f.write('\n')
                f.write(_('Patient: %s (%s), No: %s\n') % (patient.description, patient['gender'], patient['pk_identity']))
                f.write(_('Born   : %s, age: %s\n\n') % (
                        patient.get_formatted_dob(format = '%Y %b %d'),
                        patient.get_medical_age()
                ))

                # get data
                cmd = """
                        SELECT
                                vemrj.*,
                                to_char(vemrj.modified_when, 'YYYY-MM-DD HH24:MI') AS date_modified
                        FROM clin.v_emr_journal vemrj
                        WHERE pk_patient = %(pat)s
                        ORDER BY modified_when
                """
                rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': {'pat': patient['pk_identity']}}])

                f.write ((gmTools.u_box_horiz_single * 100) + '\n')
                f.write ('%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                        _('Last modified'),
                        gmTools.u_box_vert_light,
                        _('By'),
                        gmTools.u_box_vert_light,
                        ' ',
                        gmTools.u_box_vert_light,
                        _('Entry')
                ))
                f.write ((gmTools.u_box_horiz_single * 100) + '\n')

                for r in rows:
                        txt = '%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                                r['date_modified'],
                                gmTools.u_box_vert_light,
                                r['modified_by'],
                                gmTools.u_box_vert_light,
                                gmSoapDefs.soap_cat2l10n[r['soap_cat']],
                                gmTools.u_box_vert_light,
                                gmTools.wrap (
                                        text = r['narrative'].replace('\r', '') + ' (%s: %s)' % (_('When'), gmDateTime.pydt_strftime(r['clin_when'], '%Y %b %d %H:%M', none_str = '?')),
                                        width = self.__narrative_wrap_len,
                                        subsequent_indent = '%31.31s%1.1s %s ' % (' ', gmSoapDefs.soap_cat2l10n[r['soap_cat']], gmTools.u_box_vert_light)
                                )
                        )
                        f.write(txt)

                f.write ((gmTools.u_box_horiz_single * 100) + '\n')
                f.write(_('Exported: %s\n') % gmDateTime.pydt_strftime(gmDateTime.pydt_now_here(), '%Y %b %d  %H:%M:%S'))

                f.close()
                return filename

        #--------------------------------------------------------
        def save_to_file_by_encounter(self, filename=None, patient=None):
                """Export medical record into a file.

                @type filename: None (creates filename by itself) or string
                @type patient: <cPerson> instance
                """
                if patient is None:
                        raise ValueError('[%s].save_to_file_by_encounter(): no patient' % self.__class__.__name__)

                if filename is None:
                        filename = gmTools.get_unique_filename(prefix = 'gm-emr_journal-', suffix = '.txt')

                f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')
                self.__export_by_encounter(target = f, patient = patient)
                f.close()
                return filename

        #--------------------------------------------------------
        # internal API
        #--------------------------------------------------------
        def __export_by_encounter(self, target=None, patient=None):
                """
                Export medical record into a Python object.

                @type target: a python object supporting the write() API
                @type patient: <cPerson> instance
                """
                txt = _('Chronological EMR Journal\n')
                target.write(txt)
                target.write('=' * (len(txt)-1))
                target.write('\n')
                # demographics
                target.write(_('Patient: %s (%s), No: %s\n') % (patient.description, patient['gender'], patient['pk_identity']))
                target.write(_('Born   : %s, age: %s\n\n') % (
                        patient.get_formatted_dob(format = '%Y %b %d'),
                        patient.get_medical_age()
                ))
                for ext_id in patient.external_ids:
                        target.write('%s: %s (@%s)\n' % (ext_id['name'], ext_id['value'], ext_id['issuer']))
                for ch in patient.comm_channels:
                        target.write('%s: %s\n' % (ch['l10n_comm_type'], ch['url']))
                # table header
                target.write('%s%12.12s%s%11.11s%s%s%s%72.72s\n' % (
                        gmTools.u_box_top_left_arc,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))
                target.write('%s %10.10s %s %9.9s %s     %s %s\n' % (
                        gmTools.u_box_vert_light,
                        _('Encounter'),
                        gmTools.u_box_vert_light,
                        _('Doc'),
                        gmTools.u_box_vert_light,
                        gmTools.u_box_vert_light,
                        _('Narrative')
                ))
                target.write('%s%12.12s%s%11.11s%s%s%s%72.72s\n' % (
                        gmTools.u_box_T_right,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))
                # get data
                cmd = """
                        SELECT
                                to_char(vemrj.clin_when, 'YYYY-MM-DD') AS date,
                                vemrj.*,
                                (SELECT rank FROM clin.soap_cat_ranks WHERE soap_cat = vemrj.soap_cat) AS scr,
                                to_char(vemrj.modified_when, 'YYYY-MM-DD HH24:MI') AS date_modified
                        FROM clin.v_emr_journal vemrj
                        WHERE pk_patient = %s
                        ORDER BY date, pk_episode, scr, src_table
                """
                rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': [patient['pk_identity']]}])

                # write data
                prev_date = ''
                prev_doc = ''
                prev_soap = ''
                for row in rows:
                        # narrative
                        if row['narrative'] is None:
                                continue

                        txt = gmTools.wrap (
                                text = row['narrative'].replace('\r', '') + (' (%s)' % row['date_modified']),
                                width = self.__narrative_wrap_len
                        ).split('\n')

                        # same provider ?
                        curr_doc = row['modified_by']
                        if curr_doc != prev_doc:
                                prev_doc = curr_doc
                        else:
                                curr_doc = ''

                        # same soap category ?
                        curr_soap = row['soap_cat']
                        if curr_soap != prev_soap:
                                prev_soap = curr_soap

                        # same date ?
                        curr_date = row['date']
                        if curr_date != prev_date:
                                prev_date = curr_date
                                curr_doc = row['modified_by']
                                prev_doc = curr_doc
                                curr_soap = row['soap_cat']
                                prev_soap = curr_soap
                        else:
                                curr_date = ''

                        # display first part
                        target.write('%s %10.10s %s %9.9s %s %3.3s %s %s\n' % (
                                gmTools.u_box_vert_light,
                                curr_date,
                                gmTools.u_box_vert_light,
                                curr_doc,
                                gmTools.u_box_vert_light,
                                gmSoapDefs.soap_cat2l10n[curr_soap],
                                gmTools.u_box_vert_light,
                                txt[0]
                        ))

                        # only one part ?
                        if len(txt) == 1:
                                continue

                        template = '%s %10.10s %s %9.9s %s %3.3s %s %s\n'
                        for part in txt[1:]:
                                line = template % (
                                        gmTools.u_box_vert_light,
                                        '',
                                        gmTools.u_box_vert_light,
                                        '',
                                        gmTools.u_box_vert_light,
                                        ' ',
                                        gmTools.u_box_vert_light,
                                        part
                                )
                                target.write(line)

                # write footer
                target.write('%s%12.12s%s%11.11s%s%5.5s%s%72.72s\n\n' % (
                        gmTools.u_box_bottom_left_arc,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))

                target.write(_('Exported: %s\n') % gmDateTime.pydt_strftime(gmDateTime.pydt_now_here(), format = '%Y %b %d  %H:%M:%S'))

                return

#============================================================
class cMedistarSOAPExporter:
        """Export SOAP data per encounter into Medistar import format."""

        def __init__(self, patient=None):
                if patient is None:
                        raise gmExceptions.ConstructorError('<patient> argument must be instance of <cPerson>, but is: %s' % type(patient))
                self.__pat = patient

        #--------------------------------------------------------
        # external API
        #--------------------------------------------------------
        def save_to_file(self, filename=None, encounter=None, soap_cats='soapu', export_to_import_file=False):
                if not self.__pat.connected:
                        return (False, 'no active patient')

                if filename is None:
                        path = os.path.abspath(os.path.expanduser('~/gnumed/export'))
                        filename = '%s-%s-%s-%s-%s.txt' % (
                                os.path.join(path, 'Medistar-MD'),
                                time.strftime('%Y-%m-%d',time.localtime()),
                                self.__pat['lastnames'].replace(' ', '-'),
                                self.__pat['firstnames'].replace(' ', '_'),
                                self.__pat.get_formatted_dob(format = '%Y-%m-%d')
                        )

                f = open(filename, mode = 'w+t', encoding = 'cp437', errors='replace')
                status = self.__export(target = f, encounter = encounter, soap_cats = soap_cats)
                f.close()

                if export_to_import_file:
                        # detect "LW:\medistar\inst\soap.txt"
                        medistar_found = False
                        for drive in 'cdefghijklmnopqrstuvwxyz':
                                path = drive + ':\\medistar\\inst'
                                if not os.path.isdir(path):
                                        continue
                                try:
                                        import_fname = path + '\\soap.txt'
                                        open(import_fname, mode = 'w+b').close()
                                        _log.debug('exporting narrative to [%s] for Medistar import', import_fname)
                                        shutil.copyfile(filename, import_fname)
                                        medistar_found = True
                                except IOError:
                                        continue

                        if not medistar_found:
                                _log.debug('no Medistar installation found (no <LW>:\\medistar\\inst\\)')

                return (status, filename)
        #--------------------------------------------------------
        def export(self, target, encounter=None, soap_cats='soapu'):
                return self.__export(target, encounter = encounter, soap_cats = soap_cats)
        #--------------------------------------------------------
        # interal API
        #--------------------------------------------------------
        def __export(self, target=None, encounter=None, soap_cats='soapu'):
                # get data
                cmd = "select narrative from clin.v_emr_journal where pk_patient=%s and pk_encounter=%s and soap_cat=%s"
                for soap_cat in soap_cats:
                        rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': (self.__pat['pk_identity'], encounter['pk_encounter'], soap_cat)}])
                        target.write('*MD%s*\r\n' % gmSoapDefs.soap_cat2l10n[soap_cat])
                        for row in rows:
                                text = row[0]
                                if text is None:
                                        continue
                                target.write('%s\r\n' % gmTools.wrap (
                                        text = text,
                                        width = 64,
                                        eol = '\r\n'
                                ))
                return True

#============================================================
# main
#------------------------------------------------------------
def usage():
    """
        Prints application usage options to stdout.
    """
    print('usage: python gmPatientExporter [--fileout=<outputfilename>] [--conf-file=<file>] [--text-domain=<textdomain>]')
    sys.exit(0)
#------------------------------------------------------------
def run():
    """
        Main module application execution loop.
    """
    # More variable initializations
    patient = None
    patient_id = None
    patient_term = None
    pat_searcher = gmPersonSearch.cPatientSearcher_SQL()

    # App execution loop
    while patient_term != 'bye':
        patient = gmPersonSearch.ask_for_patient()
        if patient is None:
            break
        # FIXME: needed ?
        exporter = cEMRJournalExporter()
        exporter.save_to_file(patient=patient)
#        export_tool.set_patient(patient)
        # Dump patient EMR sections
#        export_tool.dump_constraints()
#        export_tool.dump_demographic_record(True)
#        export_tool.dump_clinical_record()
#        export_tool.dump_med_docs()

    # Clean ups
#    outFile.close()
#    export_tool.cleanup()
    if patient is not None:
        try:
            patient.cleanup()
        except Exception:
            print("error cleaning up patient")

#============================================================
# main
#------------------------------------------------------------
if __name__ == "__main__":

        from Gnumed.business import gmPersonSearch

        #--------------------------------------------------------
        def export_journal():

                print("Exporting EMR journal(s) ...")
                pat_searcher = gmPersonSearch.cPatientSearcher_SQL()
                while True:
                        patient = gmPersonSearch.ask_for_patient()
                        if patient is None:
                                break

                        exporter = cEMRJournalExporter()
                        print("exported into file:", exporter.save_to_file_by_encounter(patient = patient))

                        if patient is not None:
                                try:
                                        patient.cleanup()
                                except Exception:
                                        print("error cleaning up patient")
                print("Done.")
        #--------------------------------------------------------
        def export_forensics():
                pat_searcher = gmPersonSearch.cPatientSearcher_SQL()
                patient = gmPersonSearch.ask_for_patient()
                if patient is None:
                        return

                exporter = cEMRJournalExporter()
                print("exported into file:", exporter.save_to_file_by_mod_time(patient = patient))
        #--------------------------------------------------------
        print("\n\nGNUmed ASCII EMR Export")
        print("=======================")

        #export_journal()
        export_forensics()

#============================================================

Functions

def run()

Main module application execution loop.

Expand source code
def run():
    """
        Main module application execution loop.
    """
    # More variable initializations
    patient = None
    patient_id = None
    patient_term = None
    pat_searcher = gmPersonSearch.cPatientSearcher_SQL()

    # App execution loop
    while patient_term != 'bye':
        patient = gmPersonSearch.ask_for_patient()
        if patient is None:
            break
        # FIXME: needed ?
        exporter = cEMRJournalExporter()
        exporter.save_to_file(patient=patient)
#        export_tool.set_patient(patient)
        # Dump patient EMR sections
#        export_tool.dump_constraints()
#        export_tool.dump_demographic_record(True)
#        export_tool.dump_clinical_record()
#        export_tool.dump_med_docs()

    # Clean ups
#    outFile.close()
#    export_tool.cleanup()
    if patient is not None:
        try:
            patient.cleanup()
        except Exception:
            print("error cleaning up patient")
def usage()

Prints application usage options to stdout.

Expand source code
def usage():
    """
        Prints application usage options to stdout.
    """
    print('usage: python gmPatientExporter [--fileout=<outputfilename>] [--conf-file=<file>] [--text-domain=<textdomain>]')
    sys.exit(0)

Classes

class cEMRJournalExporter

Exports patient EMR into a simple chronological journal.

Expand source code
class cEMRJournalExporter:
        """Exports patient EMR into a simple chronological journal.
        """
        def __init__(self):
                self.__narrative_wrap_len = 72

        #--------------------------------------------------------
        # external API
        #--------------------------------------------------------
        def save_to_file_by_mod_time(self, filename=None, patient=None):
                if patient is None:
                        raise ValueError('[%s].save_to_file_by_mod_time(): no patient' % self.__class__.__name__)

                if filename is None:
                        filename = gmTools.get_unique_filename(prefix = 'gm-emr_by_mod_time-', suffix = '.txt')

                f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')

                self.__narrative_wrap_len = 80

                # write header
                txt = _('EMR Journal sorted by last modification time\n')
                f.write(txt)
                f.write('=' * (len(txt)-1))
                f.write('\n')
                f.write(_('Patient: %s (%s), No: %s\n') % (patient.description, patient['gender'], patient['pk_identity']))
                f.write(_('Born   : %s, age: %s\n\n') % (
                        patient.get_formatted_dob(format = '%Y %b %d'),
                        patient.get_medical_age()
                ))

                # get data
                cmd = """
                        SELECT
                                vemrj.*,
                                to_char(vemrj.modified_when, 'YYYY-MM-DD HH24:MI') AS date_modified
                        FROM clin.v_emr_journal vemrj
                        WHERE pk_patient = %(pat)s
                        ORDER BY modified_when
                """
                rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': {'pat': patient['pk_identity']}}])

                f.write ((gmTools.u_box_horiz_single * 100) + '\n')
                f.write ('%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                        _('Last modified'),
                        gmTools.u_box_vert_light,
                        _('By'),
                        gmTools.u_box_vert_light,
                        ' ',
                        gmTools.u_box_vert_light,
                        _('Entry')
                ))
                f.write ((gmTools.u_box_horiz_single * 100) + '\n')

                for r in rows:
                        txt = '%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                                r['date_modified'],
                                gmTools.u_box_vert_light,
                                r['modified_by'],
                                gmTools.u_box_vert_light,
                                gmSoapDefs.soap_cat2l10n[r['soap_cat']],
                                gmTools.u_box_vert_light,
                                gmTools.wrap (
                                        text = r['narrative'].replace('\r', '') + ' (%s: %s)' % (_('When'), gmDateTime.pydt_strftime(r['clin_when'], '%Y %b %d %H:%M', none_str = '?')),
                                        width = self.__narrative_wrap_len,
                                        subsequent_indent = '%31.31s%1.1s %s ' % (' ', gmSoapDefs.soap_cat2l10n[r['soap_cat']], gmTools.u_box_vert_light)
                                )
                        )
                        f.write(txt)

                f.write ((gmTools.u_box_horiz_single * 100) + '\n')
                f.write(_('Exported: %s\n') % gmDateTime.pydt_strftime(gmDateTime.pydt_now_here(), '%Y %b %d  %H:%M:%S'))

                f.close()
                return filename

        #--------------------------------------------------------
        def save_to_file_by_encounter(self, filename=None, patient=None):
                """Export medical record into a file.

                @type filename: None (creates filename by itself) or string
                @type patient: <cPerson> instance
                """
                if patient is None:
                        raise ValueError('[%s].save_to_file_by_encounter(): no patient' % self.__class__.__name__)

                if filename is None:
                        filename = gmTools.get_unique_filename(prefix = 'gm-emr_journal-', suffix = '.txt')

                f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')
                self.__export_by_encounter(target = f, patient = patient)
                f.close()
                return filename

        #--------------------------------------------------------
        # internal API
        #--------------------------------------------------------
        def __export_by_encounter(self, target=None, patient=None):
                """
                Export medical record into a Python object.

                @type target: a python object supporting the write() API
                @type patient: <cPerson> instance
                """
                txt = _('Chronological EMR Journal\n')
                target.write(txt)
                target.write('=' * (len(txt)-1))
                target.write('\n')
                # demographics
                target.write(_('Patient: %s (%s), No: %s\n') % (patient.description, patient['gender'], patient['pk_identity']))
                target.write(_('Born   : %s, age: %s\n\n') % (
                        patient.get_formatted_dob(format = '%Y %b %d'),
                        patient.get_medical_age()
                ))
                for ext_id in patient.external_ids:
                        target.write('%s: %s (@%s)\n' % (ext_id['name'], ext_id['value'], ext_id['issuer']))
                for ch in patient.comm_channels:
                        target.write('%s: %s\n' % (ch['l10n_comm_type'], ch['url']))
                # table header
                target.write('%s%12.12s%s%11.11s%s%s%s%72.72s\n' % (
                        gmTools.u_box_top_left_arc,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_T_down,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))
                target.write('%s %10.10s %s %9.9s %s     %s %s\n' % (
                        gmTools.u_box_vert_light,
                        _('Encounter'),
                        gmTools.u_box_vert_light,
                        _('Doc'),
                        gmTools.u_box_vert_light,
                        gmTools.u_box_vert_light,
                        _('Narrative')
                ))
                target.write('%s%12.12s%s%11.11s%s%s%s%72.72s\n' % (
                        gmTools.u_box_T_right,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_plus,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))
                # get data
                cmd = """
                        SELECT
                                to_char(vemrj.clin_when, 'YYYY-MM-DD') AS date,
                                vemrj.*,
                                (SELECT rank FROM clin.soap_cat_ranks WHERE soap_cat = vemrj.soap_cat) AS scr,
                                to_char(vemrj.modified_when, 'YYYY-MM-DD HH24:MI') AS date_modified
                        FROM clin.v_emr_journal vemrj
                        WHERE pk_patient = %s
                        ORDER BY date, pk_episode, scr, src_table
                """
                rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': [patient['pk_identity']]}])

                # write data
                prev_date = ''
                prev_doc = ''
                prev_soap = ''
                for row in rows:
                        # narrative
                        if row['narrative'] is None:
                                continue

                        txt = gmTools.wrap (
                                text = row['narrative'].replace('\r', '') + (' (%s)' % row['date_modified']),
                                width = self.__narrative_wrap_len
                        ).split('\n')

                        # same provider ?
                        curr_doc = row['modified_by']
                        if curr_doc != prev_doc:
                                prev_doc = curr_doc
                        else:
                                curr_doc = ''

                        # same soap category ?
                        curr_soap = row['soap_cat']
                        if curr_soap != prev_soap:
                                prev_soap = curr_soap

                        # same date ?
                        curr_date = row['date']
                        if curr_date != prev_date:
                                prev_date = curr_date
                                curr_doc = row['modified_by']
                                prev_doc = curr_doc
                                curr_soap = row['soap_cat']
                                prev_soap = curr_soap
                        else:
                                curr_date = ''

                        # display first part
                        target.write('%s %10.10s %s %9.9s %s %3.3s %s %s\n' % (
                                gmTools.u_box_vert_light,
                                curr_date,
                                gmTools.u_box_vert_light,
                                curr_doc,
                                gmTools.u_box_vert_light,
                                gmSoapDefs.soap_cat2l10n[curr_soap],
                                gmTools.u_box_vert_light,
                                txt[0]
                        ))

                        # only one part ?
                        if len(txt) == 1:
                                continue

                        template = '%s %10.10s %s %9.9s %s %3.3s %s %s\n'
                        for part in txt[1:]:
                                line = template % (
                                        gmTools.u_box_vert_light,
                                        '',
                                        gmTools.u_box_vert_light,
                                        '',
                                        gmTools.u_box_vert_light,
                                        ' ',
                                        gmTools.u_box_vert_light,
                                        part
                                )
                                target.write(line)

                # write footer
                target.write('%s%12.12s%s%11.11s%s%5.5s%s%72.72s\n\n' % (
                        gmTools.u_box_bottom_left_arc,
                        gmTools.u_box_horiz_single * 12,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * 11,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * 5,
                        gmTools.u_box_T_up,
                        gmTools.u_box_horiz_single * self.__narrative_wrap_len
                ))

                target.write(_('Exported: %s\n') % gmDateTime.pydt_strftime(gmDateTime.pydt_now_here(), format = '%Y %b %d  %H:%M:%S'))

                return

Methods

def save_to_file_by_encounter(self, filename=None, patient=None)

Export medical record into a file.

@type filename: None (creates filename by itself) or string @type patient: instance

Expand source code
def save_to_file_by_encounter(self, filename=None, patient=None):
        """Export medical record into a file.

        @type filename: None (creates filename by itself) or string
        @type patient: <cPerson> instance
        """
        if patient is None:
                raise ValueError('[%s].save_to_file_by_encounter(): no patient' % self.__class__.__name__)

        if filename is None:
                filename = gmTools.get_unique_filename(prefix = 'gm-emr_journal-', suffix = '.txt')

        f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')
        self.__export_by_encounter(target = f, patient = patient)
        f.close()
        return filename
def save_to_file_by_mod_time(self, filename=None, patient=None)
Expand source code
def save_to_file_by_mod_time(self, filename=None, patient=None):
        if patient is None:
                raise ValueError('[%s].save_to_file_by_mod_time(): no patient' % self.__class__.__name__)

        if filename is None:
                filename = gmTools.get_unique_filename(prefix = 'gm-emr_by_mod_time-', suffix = '.txt')

        f = open(filename, mode = 'w+t', encoding = 'utf8', errors = 'replace')

        self.__narrative_wrap_len = 80

        # write header
        txt = _('EMR Journal sorted by last modification time\n')
        f.write(txt)
        f.write('=' * (len(txt)-1))
        f.write('\n')
        f.write(_('Patient: %s (%s), No: %s\n') % (patient.description, patient['gender'], patient['pk_identity']))
        f.write(_('Born   : %s, age: %s\n\n') % (
                patient.get_formatted_dob(format = '%Y %b %d'),
                patient.get_medical_age()
        ))

        # get data
        cmd = """
                SELECT
                        vemrj.*,
                        to_char(vemrj.modified_when, 'YYYY-MM-DD HH24:MI') AS date_modified
                FROM clin.v_emr_journal vemrj
                WHERE pk_patient = %(pat)s
                ORDER BY modified_when
        """
        rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': {'pat': patient['pk_identity']}}])

        f.write ((gmTools.u_box_horiz_single * 100) + '\n')
        f.write ('%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                _('Last modified'),
                gmTools.u_box_vert_light,
                _('By'),
                gmTools.u_box_vert_light,
                ' ',
                gmTools.u_box_vert_light,
                _('Entry')
        ))
        f.write ((gmTools.u_box_horiz_single * 100) + '\n')

        for r in rows:
                txt = '%16.16s %s %9.9s %s %1.1s %s %s \n' % (
                        r['date_modified'],
                        gmTools.u_box_vert_light,
                        r['modified_by'],
                        gmTools.u_box_vert_light,
                        gmSoapDefs.soap_cat2l10n[r['soap_cat']],
                        gmTools.u_box_vert_light,
                        gmTools.wrap (
                                text = r['narrative'].replace('\r', '') + ' (%s: %s)' % (_('When'), gmDateTime.pydt_strftime(r['clin_when'], '%Y %b %d %H:%M', none_str = '?')),
                                width = self.__narrative_wrap_len,
                                subsequent_indent = '%31.31s%1.1s %s ' % (' ', gmSoapDefs.soap_cat2l10n[r['soap_cat']], gmTools.u_box_vert_light)
                        )
                )
                f.write(txt)

        f.write ((gmTools.u_box_horiz_single * 100) + '\n')
        f.write(_('Exported: %s\n') % gmDateTime.pydt_strftime(gmDateTime.pydt_now_here(), '%Y %b %d  %H:%M:%S'))

        f.close()
        return filename
class cEmrExport (constraints=None, fileout=None, patient=None)

Constructs a new instance of exporter

constraints - Exporter constraints for filtering clinical items fileout - File-like object as target for dumping operations

Expand source code
class cEmrExport:

    #--------------------------------------------------------
    def __init__(self, constraints = None, fileout = None, patient = None):
        """
        Constructs a new instance of exporter

        constraints - Exporter constraints for filtering clinical items
        fileout - File-like object as target for dumping operations
        """
        if constraints is None:
            # default constraints to None for complete emr dump
            self.__constraints = {
                'since': None,
                'until': None,
                'encounters': None,
                'episodes': None,
                'issues': None
            }
        else:
            self.__constraints = constraints
        self.__target = fileout
        self.__patient = patient
        self.lab_new_encounter = True
        self.__filtered_items = []
    #--------------------------------------------------------
    def set_constraints(self, constraints = None):
        """Sets exporter constraints.

        constraints - Exporter constraints for filtering clinical items
        """
        if constraints is None:
            # default constraints to None for complete emr dump
            self.__constraints = {
                'since': None,
                'until': None,
                'encounters': None,
                'episodes': None,
                'issues': None
            }
        else:
            self.__constraints = constraints
        return True
    #--------------------------------------------------------
    def get_constraints(self):
        """
        Retrieve exporter constraints
        """
        return self.__constraints
    #--------------------------------------------------------
    def set_patient(self, patient=None):
        """
            Sets exporter patient

            patient - Patient whose data are to be dumped
        """
        if patient is None:
            _log.error("can't set None patient for exporter")
            return
        self.__patient = patient
    #--------------------------------------------------------
    def set_output_file(self, target=None):
        """
            Sets exporter output file
            
            @param file_name - The file to dump the EMR to
            @type file_name - FileType
        """
        self.__target = target
    #--------------------------------------------------------
    def get_patient(self):
        """
            Retrieves patient whose data are to be dumped
        """
        return self.__patient
    #--------------------------------------------------------
    def cleanup(self):
        """
            Exporter class cleanup code
        """
        pass
    #--------------------------------------------------------
    def __dump_vacc_table(self, vacc_regimes):
        """
        Retrieves string containing ASCII vaccination table
        """
        emr = self.__patient.emr
        # patient dob
        patient_dob = self.__patient['dob']
        date_length = len(gmDateTime.pydt_strftime(patient_dob, '%Y %b %d')) + 2

        # dictionary of pairs indication : scheduled vaccination
        vaccinations4regimes = {}
        for a_vacc_regime in vacc_regimes:
            indication = a_vacc_regime['indication']
            vaccinations4regimes[indication] = emr.get_scheduled_vaccinations(indications=[indication])
        # vaccination regimes count
        chart_columns = len(vacc_regimes)
        # foot headers
        foot_headers = ['last booster', 'next booster']           
        # string for both: ending of vaccinations; non boosters needed
        ending_str = '='

        # chart row count, columns width and vaccination dictionary of pairs indication : given shot
        column_widths = []
        chart_rows = -1
        vaccinations = {}
        temp = -1
        for foot_header in foot_headers: # first column width
            if len(foot_header) > temp:
                temp = len(foot_header)
        column_widths.append(temp)          
        for a_vacc_regime in vacc_regimes:
            if a_vacc_regime['shots'] > chart_rows: # max_seq  -> row count 
                chart_rows = a_vacc_regime['shots']
            if (len(a_vacc_regime['l10n_indication'])) > date_length: # l10n indication -> column width
                column_widths.append(len(a_vacc_regime['l10n_indication'])) 
            else:
                column_widths.append(date_length)  # date -> column width at least
            vaccinations[a_vacc_regime['indication']] = emr.get_vaccinations(indications=[a_vacc_regime['indication']]) # given shots 4 indication

        # patient dob in top of vaccination chart 
        txt = '\nDOB: %s' % (gmDateTime.pydt_strftime(patient_dob, '%Y %b %d')) + '\n'

        # vacc chart table headers
        # top ---- header line
        for column_width in column_widths: 
            txt += column_width * '-' + '-'
        txt += '\n'                   
        # indication names header line
        txt += column_widths[0] * ' ' + '|'
        col_index = 1
        for a_vacc_regime in vacc_regimes:
            txt +=    a_vacc_regime['l10n_indication'] + (column_widths[col_index] - len(a_vacc_regime['l10n_indication'])) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        # bottom ---- header line
        for column_width in column_widths:
            txt += column_width * '-' + '-'
        txt += '\n'           

        # vacc chart data
        due_date = None           
        # previously displayed date list
        prev_displayed_date = [patient_dob]
        for a_regime in vacc_regimes:
            prev_displayed_date.append(patient_dob) # initialice with patient dob (useful for due first shot date calculation)
        # iterate data rows
        for row_index in range(0, chart_rows):              
            row_header = '#%s' %(row_index+1)
            txt += row_header + (column_widths[0] - len(row_header)) * ' ' + '|'

            for col_index in range(1, chart_columns+1):
                indication =vacc_regimes[col_index-1]['indication']
                seq_no = vacc_regimes[col_index-1]['shots']
                if row_index == seq_no: # had just ended scheduled vaccinations
                     txt += ending_str * column_widths[col_index] + '|'
                elif row_index < seq_no: # vaccination scheduled
                    try:
                        vacc_date = vaccinations[indication][row_index]['date'] # vaccination given
                        vacc_date_str = gmDateTime.pydt_strftime(vacc_date, '%Y %b %d')
                        txt +=    vacc_date_str + (column_widths[col_index] - len(vacc_date_str)) * ' ' + '|'
                        prev_displayed_date[col_index] = vacc_date
                    except Exception:
                        if row_index == 0: # due first shot
                            due_date = prev_displayed_date[col_index] + vaccinations4regimes[indication][row_index]['age_due_min'] # FIXME 'age_due_min' not properly retrieved
                        else: # due any other than first shot
                            due_date = prev_displayed_date[col_index] + vaccinations4regimes[indication][row_index]['min_interval']
                        txt += '('+ due_date.strftime('%Y-%m-%d') + ')' + (column_widths[col_index] - date_length) * ' ' + '|'
                        prev_displayed_date[col_index] = due_date
                else: # not scheduled vaccination at that position
                    txt += column_widths[col_index] * ' ' + '|'
            txt += '\n' # end of scheduled vaccination dates display
            for column_width in column_widths: # ------ separator line
                txt += column_width * '-' + '-'
            txt += '\n'

        # scheduled vaccination boosters (date retrieving)
        all_vreg_boosters = []                  
        for a_vacc_regime in vacc_regimes:
            vaccs4indication = vaccinations[a_vacc_regime['indication']] # iterate over vaccinations by indication
            given_boosters = [] # will contain given boosters for current indication
            for a_vacc in vaccs4indication:
                try:
                     if a_vacc['is_booster']:
                         given_boosters.append(a_vacc)
                except Exception:
                    # not a booster
                    pass
            if len(given_boosters) > 0:
                all_vreg_boosters.append(given_boosters[len(given_boosters)-1]) # last of given boosters
            else:
                all_vreg_boosters.append(None)

        # next booster in schedule
        all_next_boosters = []
        for a_booster in all_vreg_boosters:
            all_next_boosters.append(None)
        # scheduled vaccination boosters (displaying string)
        cont = 0
        for a_vacc_regime in vacc_regimes:
            vaccs = vaccinations4regimes[a_vacc_regime['indication']]         
            if vaccs[len(vaccs)-1]['is_booster'] == False: # booster is not scheduled/needed
                all_vreg_boosters[cont] = ending_str * column_widths[cont+1]
                all_next_boosters[cont] = ending_str * column_widths[cont+1]
            else:
                indication = vacc_regimes[cont]['indication']
                if len(vaccinations[indication]) > vacc_regimes[cont]['shots']: # boosters given
                    all_vreg_boosters[cont] = vaccinations[indication][len(vaccinations[indication])-1]['date'].strftime('%Y-%m-%d') # show last given booster date
                    scheduled_booster = vaccinations4regimes[indication][len(vaccinations4regimes[indication])-1]
                    booster_date = vaccinations[indication][len(vaccinations[indication])-1]['date'] + scheduled_booster['min_interval']
                    if booster_date < gmDateTime.pydt_now_here():
                        all_next_boosters[cont] = '<(' + booster_date.strftime('%Y-%m-%d') + ')>' # next booster is due
                    else:
                        all_next_boosters[cont] = booster_date.strftime('%Y-%m-%d')
                elif len(vaccinations[indication]) == vacc_regimes[cont]['shots']: # just finished vaccinations, begin boosters
                    all_vreg_boosters[cont] = column_widths[cont+1] * ' '
                    scheduled_booster = vaccinations4regimes[indication][len(vaccinations4regimes[indication])-1]
                    booster_date = vaccinations[indication][len(vaccinations[indication])-1]['date'] + scheduled_booster['min_interval']
                    if booster_date < gmDateTime.pydt_now_here():
                        all_next_boosters[cont] = '<(' + booster_date.strftime('%Y-%m-%d') + ')>' # next booster is due
                    else:
                        all_next_boosters[cont] = booster_date.strftime('%Y-%m-%d')
                else:
                    all_vreg_boosters[cont] = column_widths[cont+1] * ' '  # unfinished schedule
                    all_next_boosters[cont] = column_widths[cont+1] * ' '
            cont += 1

        # given boosters
        foot_header = foot_headers[0]
        col_index = 0
        txt += foot_header + (column_widths[0] - len(foot_header)) * ' ' + '|'
        col_index += 1
        for a_vacc_regime in vacc_regimes:
            txt +=    str(all_vreg_boosters[col_index-1]) + (column_widths[col_index] - len(str(all_vreg_boosters[col_index-1]))) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        for column_width in column_widths:              
            txt += column_width * '-' + '-'
        txt += '\n' 

        # next booster
        foot_header = foot_headers[1]
        col_index = 0
        txt += foot_header + (column_widths[0] - len(foot_header)) * ' ' + '|'
        col_index += 1
        for a_vacc_regime in vacc_regimes:
            txt +=    str(all_next_boosters[col_index-1]) + (column_widths[col_index] - len(str(all_next_boosters[col_index-1]))) * ' ' + '|'
            col_index += 1
        txt +=    '\n'
        for column_width in column_widths:
            txt += column_width * '-' + '-'
        txt += '\n'                   

        self.__target.write(txt)        
    #--------------------------------------------------------
    def get_vacc_table(self):
        """
        Iterate over patient scheduled regimes preparing vacc tables dump
        """           
        
        emr = self.__patient.emr
        
        # vaccination regimes
        all_vacc_regimes = emr.get_scheduled_vaccination_regimes()
        # Configurable: vacc regimes per displayed table
        # FIXME: option, post 0.1 ?
        max_regs_per_table = 4

        # Iterate over patient scheduled regimes dumping in tables of 
        # max_regs_per_table regimes per table
        reg_count = 0
        vacc_regimes = []
        for total_reg_count in range(0,len(all_vacc_regimes)):
            if reg_count%max_regs_per_table == 0:
                if len(vacc_regimes) > 0:
                    self.__dump_vacc_table(vacc_regimes)
                vacc_regimes = []
                reg_count = 0
            vacc_regimes.append(all_vacc_regimes[total_reg_count])
            reg_count += 1
        if len(vacc_regimes) > 0:
            self.__dump_vacc_table(vacc_regimes)        

    #--------------------------------------------------------
    def dump_item_fields(self, offset, item, field_list):
        """
            Dump information related to the fields of a clinical item
            offset - Number of left blank spaces
            item - Item of the field to dump
            fields - Fields to dump
        """
        txt = ''
        for a_field in field_list:
            if type(a_field) is not str:
                a_field = str(a_field, encoding='latin1', errors='replace')
            txt += '%s%s%s' % ((offset * ' '), a_field, gmTools.coalesce(item[a_field], '\n', template4value = ': %s\n'))
        return txt
    #--------------------------------------------------------
    def get_allergy_output(self, allergy, left_margin = 0):
        """
            Dumps allergy item data
            allergy - Allergy item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = ''
        txt += left_margin*' ' + _('Allergy')  + ': \n'
        txt += self.dump_item_fields((left_margin+3), allergy, ['allergene', 'substance', 'generic_specific','l10n_type', 'definite', 'reaction'])
        return txt
    #--------------------------------------------------------
    def get_vaccination_output(self, vaccination, left_margin = 0):
        """
            Dumps vaccination item data
            vaccination - Vaccination item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = ''
        txt += left_margin*' ' + _('Vaccination') + ': \n'
        txt += self.dump_item_fields((left_margin+3), vaccination, ['l10n_indication', 'vaccine', 'batch_no', 'site', 'narrative'])           
        return txt
    #--------------------------------------------------------
    def get_lab_result_output(self, lab_result, left_margin = 0):
        """
            Dumps lab result item data
            lab_request - Lab request item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if self.lab_new_encounter:
            txt += (left_margin)*' ' + _('Lab result') + ': \n'
        txt += (left_margin+3) * ' ' + lab_result['unified_name']  + ': ' + lab_result['unified_val']+ ' ' + lab_result['val_unit'] + ' (' + lab_result['material'] + ')' + '\n'
        return txt
    #--------------------------------------------------------
    def get_item_output(self, item, left_margin = 0):
        """
            Obtains formatted clinical item output dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_output(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_output(item, left_margin)
 #           txt += self.get_lab_result_output(item, left_margin)
  #          self.lab_new_encounter = False
        return txt
    #--------------------------------------------------------
    def __fetch_filtered_items(self):
        """
            Retrieve patient clinical items filtered by multiple constraints
        """
        #if not self.__patient.connected:
        #    return False
        emr = self.__patient.emr
        filtered_items = []
        filtered_items.extend(emr.get_allergies(
            since=self.__constraints['since'],
            until=self.__constraints['until'],
            encounters=self.__constraints['encounters'],
            episodes=self.__constraints['episodes'],
            issues=self.__constraints['issues'])
        )
        self.__filtered_items = filtered_items
        return True
    #--------------------------------------------------------
    def get_allergy_summary(self, allergy, left_margin = 0):
        """
            Dumps allergy item data summary
            allergy - Allergy item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = _('%sAllergy: %s, %s (noted %s)\n') % (
            left_margin * ' ',
            allergy['descriptor'],
            gmTools.coalesce(allergy['reaction'], _('unknown reaction')),
            gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d')
        )
#        txt = left_margin * ' ' \
#           + _('Allergy') + ': ' \
#            + allergy['descriptor'] + u', ' \
#            + gmTools.coalesce(allergy['reaction'], _('unknown reaction')) ' ' \
#            + _('(noted %s)') % gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d') \
#            + '\n'
        return txt
    #--------------------------------------------------------
    def get_vaccination_summary(self, vaccination, left_margin = 0):
        """
            Dumps vaccination item data summary
            vaccination - Vaccination item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = left_margin*' ' + _('Vaccination') + ': ' + vaccination['l10n_indication'] + ', ' + \
            vaccination['narrative'] + '\n'
        return txt
    #--------------------------------------------------------
    def get_lab_result_summary(self, lab_result, left_margin = 0):
        """
            Dumps lab result item data summary
            lab_request - Lab request item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if self.lab_new_encounter:
            txt += (left_margin+3)*' ' + _('Lab') + ': '  + \
                lab_result['unified_name'] + '-> ' + lab_result['unified_val'] + \
                ' ' + lab_result['val_unit']+ '\n' + '(' + lab_result['req_when'].strftime('%Y-%m-%d') + ')'
        return txt
    #--------------------------------------------------------
    def get_item_summary(self, item, left_margin = 0):
        """
            Obtains formatted clinical item summary dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_summary(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_summary(item, left_margin)
#           True: 
 #           #(item['relevant'] == True or item['abnormal'] == True):
  #          txt += self.get_lab_result_summary(item, left_margin)
   #         self.lab_new_encounter = False
        return txt
    #--------------------------------------------------------             
    def refresh_historical_tree(self, emr_tree):
        """
        checks a emr_tree constructed with this.get_historical_tree() 
        and sees if any new items need to be inserted.
        """
        #TODO , caching eliminates tree update time, so don't really need this
        self._traverse_health_issues( emr_tree, self._update_health_issue_branch)
    #--------------------------------------------------------             
    def get_historical_tree( self, emr_tree):
        self._traverse_health_issues( emr_tree, self._add_health_issue_branch)
    #--------------------------------------------------------             
    def _traverse_health_issues(self, emr_tree, health_issue_action):
        """
        Retrieves patient's historical in form of a wx tree of health issues
                                                                                        -> episodes
                                                                                           -> encounters
        Encounter object is associated with item to allow displaying its information
        """
        # variable initialization
        # this protects the emrBrowser from locking up in a paint event, e.g. in
        # some configurations which want to use emrBrowser, but don't stop tabbing
        # to emr browser when no patient selected. the effect is to displace a cNull instance
        # which is a sane representation when no patient is selected.
        if not self.__fetch_filtered_items():
            return
        emr = self.__patient.emr
        unlinked_episodes = emr.get_episodes(issues = [None])
        h_issues = []
        h_issues.extend(emr.get_health_issues(id_list = self.__constraints['issues']))
        # build the tree
        # unlinked episodes
        if len(unlinked_episodes) > 0:
            h_issues.insert(0, {
                'description': _('Unattributed episodes'),
                'pk_health_issue': None
            })
        # existing issues
        for a_health_issue in h_issues:
            health_issue_action( emr_tree, a_health_issue)

        root_item = emr_tree.GetRootItem()
        if len(h_issues) == 0:
            emr_tree.SetItemHasChildren(root_item, False)
        else:
            emr_tree.SetItemHasChildren(root_item, True)
        emr_tree.SortChildren(root_item)
    #--------------------------------------------------------
    def _add_health_issue_branch( self, emr_tree, a_health_issue):
            """appends to a wx emr_tree  , building wx treenodes from the health_issue  make this reusable for non-collapsing tree updates"""
            emr = self.__patient.emr
            root_node = emr_tree.GetRootItem()
            issue_node =  emr_tree.AppendItem(root_node, a_health_issue['description'])
            emr_tree.SetItemData(issue_node, a_health_issue)
            episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])
            if len(episodes) == 0:
                emr_tree.SetItemHasChildren(issue_node, False)
            else:
                emr_tree.SetItemHasChildren(issue_node, True)
            for an_episode in episodes:
                self._add_episode_to_tree( emr, emr_tree, issue_node,a_health_issue,  an_episode)
            emr_tree.SortChildren(issue_node)
    #--------------------------------------------------------
    def _add_episode_to_tree( self, emr , emr_tree, issue_node, a_health_issue, an_episode):
        episode_node =  emr_tree.AppendItem(issue_node, an_episode['description'])
        emr_tree.SetItemData(episode_node, an_episode)
        if an_episode['episode_open']:
            emr_tree.SetItemBold(issue_node, True)

        encounters = self._get_encounters( an_episode, emr )
        if len(encounters) == 0:
            emr_tree.SetItemHasChildren(episode_node, False)
        else:
            emr_tree.SetItemHasChildren(episode_node, True)
        self._add_encounters_to_tree( encounters,  emr_tree, episode_node )
        emr_tree.SortChildren(episode_node)
        return episode_node
    #--------------------------------------------------------
    def _add_encounters_to_tree( self, encounters, emr_tree, episode_node):
        for an_encounter in encounters:
#            label = u'%s: %s' % (an_encounter['started'].strftime('%Y-%m-%d'), an_encounter['l10n_type'])
            label = '%s: %s' % (
                an_encounter['started'].strftime('%Y-%m-%d'),
                                gmTools.unwrap (
                        gmTools.coalesce (
                        gmTools.coalesce (
                            gmTools.coalesce (
                                an_encounter.get_latest_soap (                                          # soAp
                                    soap_cat = 'a',
                                    episode = emr_tree.GetItemData(episode_node)['pk_episode']
                                ),
                                an_encounter['assessment_of_encounter']                         # or AOE
                            ),
                            an_encounter['reason_for_encounter']                                        # or RFE
                        ),
                        an_encounter['l10n_type']                                                                       # or type
                        ),
                        max_length = 40
                )
            )
            encounter_node_id = emr_tree.AppendItem(episode_node, label)
            emr_tree.SetItemData(encounter_node_id, an_encounter)
            emr_tree.SetItemHasChildren(encounter_node_id, False)
    #--------------------------------------------------------
    def _get_encounters ( self, an_episode, emr ):
               encounters = emr.get_encounters (
                   episodes = [an_episode['pk_episode']]
               )
               return encounters
    #--------------------------------------------------------
    def  _update_health_issue_branch(self, emr_tree, a_health_issue):
        emr = self.__patient.emr
        root_node = emr_tree.GetRootItem()
        id, cookie = emr_tree.GetFirstChild(root_node)
        found = False
        while id.IsOk():
            if emr_tree.GetItemText(id)  ==  a_health_issue['description']:
                found = True
                break
            id,cookie = emr_tree.GetNextChild( root_node, cookie)

        if not found:
            _log.error("health issue %s should exist in tree already", a_health_issue['description'] )
            return
        issue_node = id
        episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])

        #check for removed episode and update tree
        tree_episodes = {} 
        id_episode, cookie = emr_tree.GetFirstChild(issue_node)
        while id_episode.IsOk():
            tree_episodes[ emr_tree.GetItemData(id_episode)['pk_episode'] ]= id_episode
            id_episode,cookie = emr_tree.GetNextChild( issue_node, cookie)

        existing_episode_pk = [ e['pk_episode'] for e in episodes]
        missing_tree_pk = [ pk for pk in tree_episodes if pk not in existing_episode_pk]
        for pk in missing_tree_pk:
            emr_tree.Remove( tree_episodes[pk] )

        added_episode_pk = [pk for pk in existing_episode_pk if pk not in tree_episodes]
        add_episodes = [ e for e in episodes if e['pk_episode'] in added_episode_pk]

        #check for added episodes and update tree
        for an_episode in add_episodes:
            node = self._add_episode_to_tree( emr, emr_tree, issue_node, a_health_issue, an_episode)
            tree_episodes[an_episode['pk_episode']] = node

        for an_episode in episodes:
            # found episode, check for encounter change
            try:
                #print "getting id_episode of ", an_episode['pk_episode']
                id_episode = tree_episodes[an_episode['pk_episode']]    
            except Exception:
                import pdb
                pdb.set_trace()
            # get a map of encounters in the tree by pk_encounter as key
            tree_enc = {}
            id_encounter, cookie = emr_tree.GetFirstChild(id_episode)
            while id_encounter.IsOk():
                tree_enc[ emr_tree.GetItemData(id_encounter)['pk_encounter'] ] = id_encounter
                id_encounter,cookie = emr_tree.GetNextChild(id_episode, cookie)

            # remove encounters in tree not in existing encounters in episode
#            encounters = self._get_encounters( a_health_issue, an_episode, emr )
            encounters = self._get_encounters( an_episode, emr )
            existing_enc_pk = [ enc['pk_encounter'] for enc in encounters]
            missing_enc_pk = [ pk  for pk in tree_enc if pk not in existing_enc_pk]
            for pk in missing_enc_pk:
                emr_tree.Remove( tree_enc[pk] )

            # check for added encounter
            added_enc_pk = [ pk for pk in existing_enc_pk if pk not in tree_enc ]
            add_encounters = [ enc for enc in encounters if enc['pk_encounter'] in added_enc_pk]
            if add_encounters != []:
                #print "DEBUG found encounters to add"
                self._add_encounters_to_tree( add_encounters, emr_tree, id_episode)
    #--------------------------------------------------------
    def get_summary_info(self, left_margin = 0):
        """
        Dumps patient EMR summary
        """
        txt = ''
        for an_item in self.__filtered_items:
            txt += self.get_item_summary(an_item, left_margin)
        return txt
    #--------------------------------------------------------
    def get_episode_summary (self, episode, left_margin = 0):
        """Dumps episode specific data"""
        emr = self.__patient.emr
        encs = emr.get_encounters(episodes = [episode['pk_episode']])
        if encs is None:
            txt = left_margin * ' ' + _('Error retrieving encounters for episode\n%s') % str(episode)
            return txt
        no_encs = len(encs)
        if no_encs == 0:
            txt = left_margin * ' ' + _('There are no encounters for this episode.')
            return txt
        if episode['episode_open']:
            status = _('active')
        else:
            status = _('finished')
        first_encounter = emr.get_first_encounter(episode_id = episode['pk_episode'])
        last_encounter = emr.get_last_encounter(episode_id = episode['pk_episode'])
        txt = _(
            '%sEpisode "%s" [%s]\n'
            '%sEncounters: %s (%s - %s)\n'
            '%sLast worked on: %s\n'
        ) % (
            left_margin * ' ', episode['description'], status,
            left_margin * ' ', no_encs, first_encounter['started'].strftime('%m/%Y'), last_encounter['last_affirmed'].strftime('%m/%Y'),
            left_margin * ' ', last_encounter['last_affirmed'].strftime('%Y-%m-%d %H:%M')
        )
        return txt
    #--------------------------------------------------------
    def get_encounter_info(self, episode, encounter, left_margin = 0):
        """
        Dumps encounter specific data (rfe, aoe and soap)
        """
        emr = self.__patient.emr
        # general
        txt = (' ' * left_margin) + '#%s: %s - %s   %s' % (
            encounter['pk_encounter'],
            encounter['started'].strftime('%Y-%m-%d %H:%M'),
            encounter['last_affirmed'].strftime('%H:%M (%Z)'),
            encounter['l10n_type']
        )
        if (encounter['assessment_of_encounter'] is not None) and (len(encounter['assessment_of_encounter']) > 0):
            txt += ' "%s"' % encounter['assessment_of_encounter']
        txt += '\n\n'

        # rfe/aoe
        txt += (' ' * left_margin) + '%s: %s\n' % (_('RFE'), encounter['reason_for_encounter'])
        txt += (' ' * left_margin) + '%s: %s\n' % (_('AOE'), encounter['assessment_of_encounter'])

        # soap
        soap_cat_labels = {
            's': _('Subjective'),
            'o': _('Objective'),
            'a': _('Assessment'),
            'p': _('Plan'),
            'u': _('Unspecified'),
            None: _('Administrative')
        }
        eol_w_margin = '\n' + (' ' * (left_margin+3))
        for soap_cat in 'soapu':
            soap_cat_narratives = emr.get_clin_narrative (
                episodes = [episode['pk_episode']],
                encounters = [encounter['pk_encounter']],
                soap_cats = [soap_cat]
            )
            if soap_cat_narratives is None:
                continue
            if len(soap_cat_narratives) == 0:
                continue
            txt += (' ' * left_margin) + soap_cat_labels[soap_cat] + ':\n'
            for soap_entry in soap_cat_narratives:
                txt += gmTools.wrap (
                    '%s %.8s: %s\n' % (
                        soap_entry['date'].strftime('%d.%m. %H:%M'),
                        soap_entry['modified_by'],
                        soap_entry['narrative']
                    ), 75
                )

#                txt += (
 #                   (' ' * (left_margin+3)) +
  #                  soap_entry['date'].strftime('%H:%M %.8s: ') % soap_entry['modified_by'] +
   #                 soap_entry['narrative'].replace('\n', eol_w_margin) +
    #                '\n'
     #           )
                #FIXME: add diagnoses

        # items
        for an_item in self.__filtered_items:
            if an_item['pk_encounter'] == encounter['pk_encounter']:
                txt += self.get_item_output(an_item, left_margin)
        return txt

    #--------------------------------------------------------  
    def dump_historical_tree(self):
        """Dumps patient's historical in form of a tree of health issues
                                                        -> episodes
                                                           -> encounters
                                                              -> clinical items
        """

        # fecth all values
        self.__fetch_filtered_items()
        emr = self.__patient.emr

        # dump clinically relevant items summary
        for an_item in self.__filtered_items:
            self.__target.write(self.get_item_summary(an_item, 3))
                
        # begin with the tree
        h_issues = []
        h_issues.extend(emr.get_health_issues(id_list = self.__constraints['issues']))
        # unlinked episodes
        unlinked_episodes = emr.get_episodes(issues = [None])
        if len(unlinked_episodes) > 0:
            h_issues.insert(0, {'description':_('Unattributed episodes'), 'pk_health_issue':None})        
        for a_health_issue in h_issues:
            self.__target.write('\n' + 3*' ' + 'Health Issue: ' + a_health_issue['description'] + '\n')
            episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])
            for an_episode in episodes:
               self.__target.write('\n' + 6*' ' + 'Episode: ' + an_episode['description'] + '\n')
               if a_health_issue['pk_health_issue'] is None:
                  issues = None
               else:
                  issues = [a_health_issue['pk_health_issue']]
               encounters = emr.get_encounters (
                  since = self.__constraints['since'],
                  until = self.__constraints['until'],
                  id_list = self.__constraints['encounters'],
                  episodes = [an_episode['pk_episode']],
                  issues = issues
               )
               for an_encounter in encounters:
                    # title
                    self.lab_new_encounter = True
                    self.__target.write(
                        '\n            %s %s: %s - %s (%s)\n' % (
                            _('Encounter'),
                            an_encounter['l10n_type'],
                            an_encounter['started'].strftime('%A, %Y-%m-%d %H:%M'),
                            an_encounter['last_affirmed'].strftime('%m-%d %H:%M'),
                            an_encounter['assessment_of_encounter']
                        )
                    )
                    self.__target.write(self.get_encounter_info(an_episode, an_encounter, 12))
    #--------------------------------------------------------
    def dump_clinical_record(self):
        """
        Dumps in ASCII format patient's clinical record
        """
        emr = self.__patient.emr
        if emr is None:
            _log.error('cannot get EMR text dump')
            print((_(
                'An error occurred while retrieving a text\n'
                'dump of the EMR for the active patient.\n\n'
                'Please check the log file for details.'
            )))
            return None
        self.__target.write('\nOverview\n')
        self.__target.write('--------\n')
        self.__target.write("1) Allergy status (for details, see below):\n\n")
        for allergy in       emr.get_allergies():
            self.__target.write("    " + allergy['descriptor'] + "\n\n")
        self.__target.write("2) Vaccination status (* indicates booster):\n")
#        self.get_vacc_table()
        self.__target.write("\n3) Historical:\n\n")
        self.dump_historical_tree()

        try:
            emr.cleanup()
        except Exception:
            print("error cleaning up EMR")
    #--------------------------------------------------------
    def dump_med_docs(self):
        """
            Dumps patient stored medical documents

        """
        doc_folder = self.__patient.get_document_folder()

        self.__target.write('\n4) Medical documents: (date) reference - type "comment"\n')
        self.__target.write('                          object - comment')

        docs = doc_folder.get_documents()
        for doc in docs:
            self.__target.write('\n\n    (%s) %s - %s "%s"' % (
                doc['clin_when'].strftime('%Y-%m-%d'),
                doc['ext_ref'],
                doc['l10n_type'],
                doc['comment'])
            )
            for part in doc.parts:
                self.__target.write('\n         %s - %s' % (
                    part['seq_idx'],
                    part['obj_comment'])
                )
        self.__target.write('\n\n')
    #--------------------------------------------------------     
    def dump_demographic_record(self, all = False):
        """
            Dumps in ASCII format some basic patient's demographic data
        """
        if self.__patient is None:
            _log.error('cannot get Demographic export')
            print((_(
                'An error occurred while Demographic record export\n'
                'Please check the log file for details.'
            )))
            return None

        self.__target.write('\n\n\nDemographics')
        self.__target.write('\n------------\n')
        self.__target.write('    Id: %s \n' % self.__patient['pk_identity'])
        cont = 0
        for name in self.__patient.get_names():
            if cont == 0:
                self.__target.write('    Name (Active): %s, %s\n' % (name['firstnames'], name['lastnames']) )
            else:
                self.__target.write('    Name %s: %s, %s\n' % (cont, name['firstnames'], name['lastnames']))
            cont += 1
        self.__target.write('    Gender: %s\n' % self.__patient['gender'])
        self.__target.write('    Title: %s\n' % self.__patient['title'])
        self.__target.write('    Dob: %s\n' % self.__patient.get_formatted_dob(format = '%Y-%m-%d'))
        self.__target.write('    Medical age: %s\n' % self.__patient.get_medical_age())
    #--------------------------------------------------------
    def dump_constraints(self):
        """
            Dumps exporter filtering constraints
        """
        self.__first_constraint = True
        if not self.__constraints['since'] is None:
            self.dump_constraints_header()
            self.__target.write('\nSince: %s' % self.__constraints['since'].strftime('%Y-%m-%d'))

        if not self.__constraints['until'] is None:
            self.dump_constraints_header()
            self.__target.write('\nUntil: %s' % self.__constraints['until'].strftime('%Y-%m-%d'))

        if not self.__constraints['encounters'] is None:
            self.dump_constraints_header()
            self.__target.write('\nEncounters: ')
            for enc in self.__constraints['encounters']:
                self.__target.write(str(enc) + ' ')

        if not self.__constraints['episodes'] is None:
            self.dump_constraints_header()
            self.__target.write('\nEpisodes: ')
            for epi in self.__constraints['episodes']:
                self.__target.write(str(epi) + ' ')

        if not self.__constraints['issues'] is None:
            self.dump_constraints_header()
            self.__target.write('\nIssues: ')
            for iss in self.__constraints['issues']:
                self.__target.write(str(iss) + ' ')
    #--------------------------------------------------------
    def dump_constraints_header(self):
        """
            Dumps constraints header
        """
        if self.__first_constraint == True:
            self.__target.write('\nClinical items dump constraints\n')
            self.__target.write('-'*(len(head_txt)-2))
            self.__first_constraint = False

Methods

def cleanup(self)

Exporter class cleanup code

Expand source code
def cleanup(self):
    """
        Exporter class cleanup code
    """
    pass
def dump_clinical_record(self)

Dumps in ASCII format patient's clinical record

Expand source code
    def dump_clinical_record(self):
        """
        Dumps in ASCII format patient's clinical record
        """
        emr = self.__patient.emr
        if emr is None:
            _log.error('cannot get EMR text dump')
            print((_(
                'An error occurred while retrieving a text\n'
                'dump of the EMR for the active patient.\n\n'
                'Please check the log file for details.'
            )))
            return None
        self.__target.write('\nOverview\n')
        self.__target.write('--------\n')
        self.__target.write("1) Allergy status (for details, see below):\n\n")
        for allergy in       emr.get_allergies():
            self.__target.write("    " + allergy['descriptor'] + "\n\n")
        self.__target.write("2) Vaccination status (* indicates booster):\n")
#        self.get_vacc_table()
        self.__target.write("\n3) Historical:\n\n")
        self.dump_historical_tree()

        try:
            emr.cleanup()
        except Exception:
            print("error cleaning up EMR")
def dump_constraints(self)

Dumps exporter filtering constraints

Expand source code
def dump_constraints(self):
    """
        Dumps exporter filtering constraints
    """
    self.__first_constraint = True
    if not self.__constraints['since'] is None:
        self.dump_constraints_header()
        self.__target.write('\nSince: %s' % self.__constraints['since'].strftime('%Y-%m-%d'))

    if not self.__constraints['until'] is None:
        self.dump_constraints_header()
        self.__target.write('\nUntil: %s' % self.__constraints['until'].strftime('%Y-%m-%d'))

    if not self.__constraints['encounters'] is None:
        self.dump_constraints_header()
        self.__target.write('\nEncounters: ')
        for enc in self.__constraints['encounters']:
            self.__target.write(str(enc) + ' ')

    if not self.__constraints['episodes'] is None:
        self.dump_constraints_header()
        self.__target.write('\nEpisodes: ')
        for epi in self.__constraints['episodes']:
            self.__target.write(str(epi) + ' ')

    if not self.__constraints['issues'] is None:
        self.dump_constraints_header()
        self.__target.write('\nIssues: ')
        for iss in self.__constraints['issues']:
            self.__target.write(str(iss) + ' ')
def dump_constraints_header(self)

Dumps constraints header

Expand source code
def dump_constraints_header(self):
    """
        Dumps constraints header
    """
    if self.__first_constraint == True:
        self.__target.write('\nClinical items dump constraints\n')
        self.__target.write('-'*(len(head_txt)-2))
        self.__first_constraint = False
def dump_demographic_record(self, all=False)

Dumps in ASCII format some basic patient's demographic data

Expand source code
def dump_demographic_record(self, all = False):
    """
        Dumps in ASCII format some basic patient's demographic data
    """
    if self.__patient is None:
        _log.error('cannot get Demographic export')
        print((_(
            'An error occurred while Demographic record export\n'
            'Please check the log file for details.'
        )))
        return None

    self.__target.write('\n\n\nDemographics')
    self.__target.write('\n------------\n')
    self.__target.write('    Id: %s \n' % self.__patient['pk_identity'])
    cont = 0
    for name in self.__patient.get_names():
        if cont == 0:
            self.__target.write('    Name (Active): %s, %s\n' % (name['firstnames'], name['lastnames']) )
        else:
            self.__target.write('    Name %s: %s, %s\n' % (cont, name['firstnames'], name['lastnames']))
        cont += 1
    self.__target.write('    Gender: %s\n' % self.__patient['gender'])
    self.__target.write('    Title: %s\n' % self.__patient['title'])
    self.__target.write('    Dob: %s\n' % self.__patient.get_formatted_dob(format = '%Y-%m-%d'))
    self.__target.write('    Medical age: %s\n' % self.__patient.get_medical_age())
def dump_historical_tree(self)

Dumps patient's historical in form of a tree of health issues -> episodes -> encounters -> clinical items

Expand source code
def dump_historical_tree(self):
    """Dumps patient's historical in form of a tree of health issues
                                                    -> episodes
                                                       -> encounters
                                                          -> clinical items
    """

    # fecth all values
    self.__fetch_filtered_items()
    emr = self.__patient.emr

    # dump clinically relevant items summary
    for an_item in self.__filtered_items:
        self.__target.write(self.get_item_summary(an_item, 3))
            
    # begin with the tree
    h_issues = []
    h_issues.extend(emr.get_health_issues(id_list = self.__constraints['issues']))
    # unlinked episodes
    unlinked_episodes = emr.get_episodes(issues = [None])
    if len(unlinked_episodes) > 0:
        h_issues.insert(0, {'description':_('Unattributed episodes'), 'pk_health_issue':None})        
    for a_health_issue in h_issues:
        self.__target.write('\n' + 3*' ' + 'Health Issue: ' + a_health_issue['description'] + '\n')
        episodes = emr.get_episodes(id_list=self.__constraints['episodes'], issues = [a_health_issue['pk_health_issue']])
        for an_episode in episodes:
           self.__target.write('\n' + 6*' ' + 'Episode: ' + an_episode['description'] + '\n')
           if a_health_issue['pk_health_issue'] is None:
              issues = None
           else:
              issues = [a_health_issue['pk_health_issue']]
           encounters = emr.get_encounters (
              since = self.__constraints['since'],
              until = self.__constraints['until'],
              id_list = self.__constraints['encounters'],
              episodes = [an_episode['pk_episode']],
              issues = issues
           )
           for an_encounter in encounters:
                # title
                self.lab_new_encounter = True
                self.__target.write(
                    '\n            %s %s: %s - %s (%s)\n' % (
                        _('Encounter'),
                        an_encounter['l10n_type'],
                        an_encounter['started'].strftime('%A, %Y-%m-%d %H:%M'),
                        an_encounter['last_affirmed'].strftime('%m-%d %H:%M'),
                        an_encounter['assessment_of_encounter']
                    )
                )
                self.__target.write(self.get_encounter_info(an_episode, an_encounter, 12))
def dump_item_fields(self, offset, item, field_list)

Dump information related to the fields of a clinical item offset - Number of left blank spaces item - Item of the field to dump fields - Fields to dump

Expand source code
def dump_item_fields(self, offset, item, field_list):
    """
        Dump information related to the fields of a clinical item
        offset - Number of left blank spaces
        item - Item of the field to dump
        fields - Fields to dump
    """
    txt = ''
    for a_field in field_list:
        if type(a_field) is not str:
            a_field = str(a_field, encoding='latin1', errors='replace')
        txt += '%s%s%s' % ((offset * ' '), a_field, gmTools.coalesce(item[a_field], '\n', template4value = ': %s\n'))
    return txt
def dump_med_docs(self)

Dumps patient stored medical documents

Expand source code
def dump_med_docs(self):
    """
        Dumps patient stored medical documents

    """
    doc_folder = self.__patient.get_document_folder()

    self.__target.write('\n4) Medical documents: (date) reference - type "comment"\n')
    self.__target.write('                          object - comment')

    docs = doc_folder.get_documents()
    for doc in docs:
        self.__target.write('\n\n    (%s) %s - %s "%s"' % (
            doc['clin_when'].strftime('%Y-%m-%d'),
            doc['ext_ref'],
            doc['l10n_type'],
            doc['comment'])
        )
        for part in doc.parts:
            self.__target.write('\n         %s - %s' % (
                part['seq_idx'],
                part['obj_comment'])
            )
    self.__target.write('\n\n')
def get_allergy_output(self, allergy, left_margin=0)

Dumps allergy item data allergy - Allergy item to dump left_margin - Number of spaces on the left margin

Expand source code
def get_allergy_output(self, allergy, left_margin = 0):
    """
        Dumps allergy item data
        allergy - Allergy item to dump
        left_margin - Number of spaces on the left margin
    """
    txt = ''
    txt += left_margin*' ' + _('Allergy')  + ': \n'
    txt += self.dump_item_fields((left_margin+3), allergy, ['allergene', 'substance', 'generic_specific','l10n_type', 'definite', 'reaction'])
    return txt
def get_allergy_summary(self, allergy, left_margin=0)

Dumps allergy item data summary allergy - Allergy item to dump left_margin - Number of spaces on the left margin

Expand source code
    def get_allergy_summary(self, allergy, left_margin = 0):
        """
            Dumps allergy item data summary
            allergy - Allergy item to dump
            left_margin - Number of spaces on the left margin
        """
        txt = _('%sAllergy: %s, %s (noted %s)\n') % (
            left_margin * ' ',
            allergy['descriptor'],
            gmTools.coalesce(allergy['reaction'], _('unknown reaction')),
            gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d')
        )
#        txt = left_margin * ' ' \
#           + _('Allergy') + ': ' \
#            + allergy['descriptor'] + u', ' \
#            + gmTools.coalesce(allergy['reaction'], _('unknown reaction')) ' ' \
#            + _('(noted %s)') % gmDateTime.pydt_strftime(allergy['date'], '%Y %b %d') \
#            + '\n'
        return txt
def get_constraints(self)

Retrieve exporter constraints

Expand source code
def get_constraints(self):
    """
    Retrieve exporter constraints
    """
    return self.__constraints
def get_encounter_info(self, episode, encounter, left_margin=0)

Dumps encounter specific data (rfe, aoe and soap)

Expand source code
    def get_encounter_info(self, episode, encounter, left_margin = 0):
        """
        Dumps encounter specific data (rfe, aoe and soap)
        """
        emr = self.__patient.emr
        # general
        txt = (' ' * left_margin) + '#%s: %s - %s   %s' % (
            encounter['pk_encounter'],
            encounter['started'].strftime('%Y-%m-%d %H:%M'),
            encounter['last_affirmed'].strftime('%H:%M (%Z)'),
            encounter['l10n_type']
        )
        if (encounter['assessment_of_encounter'] is not None) and (len(encounter['assessment_of_encounter']) > 0):
            txt += ' "%s"' % encounter['assessment_of_encounter']
        txt += '\n\n'

        # rfe/aoe
        txt += (' ' * left_margin) + '%s: %s\n' % (_('RFE'), encounter['reason_for_encounter'])
        txt += (' ' * left_margin) + '%s: %s\n' % (_('AOE'), encounter['assessment_of_encounter'])

        # soap
        soap_cat_labels = {
            's': _('Subjective'),
            'o': _('Objective'),
            'a': _('Assessment'),
            'p': _('Plan'),
            'u': _('Unspecified'),
            None: _('Administrative')
        }
        eol_w_margin = '\n' + (' ' * (left_margin+3))
        for soap_cat in 'soapu':
            soap_cat_narratives = emr.get_clin_narrative (
                episodes = [episode['pk_episode']],
                encounters = [encounter['pk_encounter']],
                soap_cats = [soap_cat]
            )
            if soap_cat_narratives is None:
                continue
            if len(soap_cat_narratives) == 0:
                continue
            txt += (' ' * left_margin) + soap_cat_labels[soap_cat] + ':\n'
            for soap_entry in soap_cat_narratives:
                txt += gmTools.wrap (
                    '%s %.8s: %s\n' % (
                        soap_entry['date'].strftime('%d.%m. %H:%M'),
                        soap_entry['modified_by'],
                        soap_entry['narrative']
                    ), 75
                )

#                txt += (
 #                   (' ' * (left_margin+3)) +
  #                  soap_entry['date'].strftime('%H:%M %.8s: ') % soap_entry['modified_by'] +
   #                 soap_entry['narrative'].replace('\n', eol_w_margin) +
    #                '\n'
     #           )
                #FIXME: add diagnoses

        # items
        for an_item in self.__filtered_items:
            if an_item['pk_encounter'] == encounter['pk_encounter']:
                txt += self.get_item_output(an_item, left_margin)
        return txt
def get_episode_summary(self, episode, left_margin=0)

Dumps episode specific data

Expand source code
def get_episode_summary (self, episode, left_margin = 0):
    """Dumps episode specific data"""
    emr = self.__patient.emr
    encs = emr.get_encounters(episodes = [episode['pk_episode']])
    if encs is None:
        txt = left_margin * ' ' + _('Error retrieving encounters for episode\n%s') % str(episode)
        return txt
    no_encs = len(encs)
    if no_encs == 0:
        txt = left_margin * ' ' + _('There are no encounters for this episode.')
        return txt
    if episode['episode_open']:
        status = _('active')
    else:
        status = _('finished')
    first_encounter = emr.get_first_encounter(episode_id = episode['pk_episode'])
    last_encounter = emr.get_last_encounter(episode_id = episode['pk_episode'])
    txt = _(
        '%sEpisode "%s" [%s]\n'
        '%sEncounters: %s (%s - %s)\n'
        '%sLast worked on: %s\n'
    ) % (
        left_margin * ' ', episode['description'], status,
        left_margin * ' ', no_encs, first_encounter['started'].strftime('%m/%Y'), last_encounter['last_affirmed'].strftime('%m/%Y'),
        left_margin * ' ', last_encounter['last_affirmed'].strftime('%Y-%m-%d %H:%M')
    )
    return txt
def get_historical_tree(self, emr_tree)
Expand source code
def get_historical_tree( self, emr_tree):
    self._traverse_health_issues( emr_tree, self._add_health_issue_branch)
def get_item_output(self, item, left_margin=0)

Obtains formatted clinical item output dump item - The clinical item to dump left_margin - Number of spaces on the left margin

Expand source code
    def get_item_output(self, item, left_margin = 0):
        """
            Obtains formatted clinical item output dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_output(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_output(item, left_margin)
 #           txt += self.get_lab_result_output(item, left_margin)
  #          self.lab_new_encounter = False
        return txt
def get_item_summary(self, item, left_margin=0)

Obtains formatted clinical item summary dump item - The clinical item to dump left_margin - Number of spaces on the left margin

Expand source code
    def get_item_summary(self, item, left_margin = 0):
        """
            Obtains formatted clinical item summary dump
            item - The clinical item to dump
            left_margin - Number of spaces on the left margin             
        """
        txt = ''
        if isinstance(item, gmAllergy.cAllergy):
            txt += self.get_allergy_summary(item, left_margin)
#        elif isinstance(item, gmVaccination.cVaccination):
 #           txt += self.get_vaccination_summary(item, left_margin)
#           True: 
 #           #(item['relevant'] == True or item['abnormal'] == True):
  #          txt += self.get_lab_result_summary(item, left_margin)
   #         self.lab_new_encounter = False
        return txt
def get_lab_result_output(self, lab_result, left_margin=0)

Dumps lab result item data lab_request - Lab request item to dump left_margin - Number of spaces on the left margin

Expand source code
def get_lab_result_output(self, lab_result, left_margin = 0):
    """
        Dumps lab result item data
        lab_request - Lab request item to dump
        left_margin - Number of spaces on the left margin             
    """
    txt = ''
    if self.lab_new_encounter:
        txt += (left_margin)*' ' + _('Lab result') + ': \n'
    txt += (left_margin+3) * ' ' + lab_result['unified_name']  + ': ' + lab_result['unified_val']+ ' ' + lab_result['val_unit'] + ' (' + lab_result['material'] + ')' + '\n'
    return txt
def get_lab_result_summary(self, lab_result, left_margin=0)

Dumps lab result item data summary lab_request - Lab request item to dump left_margin - Number of spaces on the left margin

Expand source code
def get_lab_result_summary(self, lab_result, left_margin = 0):
    """
        Dumps lab result item data summary
        lab_request - Lab request item to dump
        left_margin - Number of spaces on the left margin             
    """
    txt = ''
    if self.lab_new_encounter:
        txt += (left_margin+3)*' ' + _('Lab') + ': '  + \
            lab_result['unified_name'] + '-> ' + lab_result['unified_val'] + \
            ' ' + lab_result['val_unit']+ '\n' + '(' + lab_result['req_when'].strftime('%Y-%m-%d') + ')'
    return txt
def get_patient(self)

Retrieves patient whose data are to be dumped

Expand source code
def get_patient(self):
    """
        Retrieves patient whose data are to be dumped
    """
    return self.__patient
def get_summary_info(self, left_margin=0)

Dumps patient EMR summary

Expand source code
def get_summary_info(self, left_margin = 0):
    """
    Dumps patient EMR summary
    """
    txt = ''
    for an_item in self.__filtered_items:
        txt += self.get_item_summary(an_item, left_margin)
    return txt
def get_vacc_table(self)

Iterate over patient scheduled regimes preparing vacc tables dump

Expand source code
def get_vacc_table(self):
    """
    Iterate over patient scheduled regimes preparing vacc tables dump
    """           
    
    emr = self.__patient.emr
    
    # vaccination regimes
    all_vacc_regimes = emr.get_scheduled_vaccination_regimes()
    # Configurable: vacc regimes per displayed table
    # FIXME: option, post 0.1 ?
    max_regs_per_table = 4

    # Iterate over patient scheduled regimes dumping in tables of 
    # max_regs_per_table regimes per table
    reg_count = 0
    vacc_regimes = []
    for total_reg_count in range(0,len(all_vacc_regimes)):
        if reg_count%max_regs_per_table == 0:
            if len(vacc_regimes) > 0:
                self.__dump_vacc_table(vacc_regimes)
            vacc_regimes = []
            reg_count = 0
        vacc_regimes.append(all_vacc_regimes[total_reg_count])
        reg_count += 1
    if len(vacc_regimes) > 0:
        self.__dump_vacc_table(vacc_regimes)        
def get_vaccination_output(self, vaccination, left_margin=0)

Dumps vaccination item data vaccination - Vaccination item to dump left_margin - Number of spaces on the left margin

Expand source code
def get_vaccination_output(self, vaccination, left_margin = 0):
    """
        Dumps vaccination item data
        vaccination - Vaccination item to dump
        left_margin - Number of spaces on the left margin
    """
    txt = ''
    txt += left_margin*' ' + _('Vaccination') + ': \n'
    txt += self.dump_item_fields((left_margin+3), vaccination, ['l10n_indication', 'vaccine', 'batch_no', 'site', 'narrative'])           
    return txt
def get_vaccination_summary(self, vaccination, left_margin=0)

Dumps vaccination item data summary vaccination - Vaccination item to dump left_margin - Number of spaces on the left margin

Expand source code
def get_vaccination_summary(self, vaccination, left_margin = 0):
    """
        Dumps vaccination item data summary
        vaccination - Vaccination item to dump
        left_margin - Number of spaces on the left margin
    """
    txt = left_margin*' ' + _('Vaccination') + ': ' + vaccination['l10n_indication'] + ', ' + \
        vaccination['narrative'] + '\n'
    return txt
def refresh_historical_tree(self, emr_tree)

checks a emr_tree constructed with this.get_historical_tree() and sees if any new items need to be inserted.

Expand source code
def refresh_historical_tree(self, emr_tree):
    """
    checks a emr_tree constructed with this.get_historical_tree() 
    and sees if any new items need to be inserted.
    """
    #TODO , caching eliminates tree update time, so don't really need this
    self._traverse_health_issues( emr_tree, self._update_health_issue_branch)
def set_constraints(self, constraints=None)

Sets exporter constraints.

constraints - Exporter constraints for filtering clinical items

Expand source code
def set_constraints(self, constraints = None):
    """Sets exporter constraints.

    constraints - Exporter constraints for filtering clinical items
    """
    if constraints is None:
        # default constraints to None for complete emr dump
        self.__constraints = {
            'since': None,
            'until': None,
            'encounters': None,
            'episodes': None,
            'issues': None
        }
    else:
        self.__constraints = constraints
    return True
def set_output_file(self, target=None)

Sets exporter output file

@param file_name - The file to dump the EMR to @type file_name - FileType

Expand source code
def set_output_file(self, target=None):
    """
        Sets exporter output file
        
        @param file_name - The file to dump the EMR to
        @type file_name - FileType
    """
    self.__target = target
def set_patient(self, patient=None)

Sets exporter patient

patient - Patient whose data are to be dumped

Expand source code
def set_patient(self, patient=None):
    """
        Sets exporter patient

        patient - Patient whose data are to be dumped
    """
    if patient is None:
        _log.error("can't set None patient for exporter")
        return
    self.__patient = patient
class cMedistarSOAPExporter (patient=None)

Export SOAP data per encounter into Medistar import format.

Expand source code
class cMedistarSOAPExporter:
        """Export SOAP data per encounter into Medistar import format."""

        def __init__(self, patient=None):
                if patient is None:
                        raise gmExceptions.ConstructorError('<patient> argument must be instance of <cPerson>, but is: %s' % type(patient))
                self.__pat = patient

        #--------------------------------------------------------
        # external API
        #--------------------------------------------------------
        def save_to_file(self, filename=None, encounter=None, soap_cats='soapu', export_to_import_file=False):
                if not self.__pat.connected:
                        return (False, 'no active patient')

                if filename is None:
                        path = os.path.abspath(os.path.expanduser('~/gnumed/export'))
                        filename = '%s-%s-%s-%s-%s.txt' % (
                                os.path.join(path, 'Medistar-MD'),
                                time.strftime('%Y-%m-%d',time.localtime()),
                                self.__pat['lastnames'].replace(' ', '-'),
                                self.__pat['firstnames'].replace(' ', '_'),
                                self.__pat.get_formatted_dob(format = '%Y-%m-%d')
                        )

                f = open(filename, mode = 'w+t', encoding = 'cp437', errors='replace')
                status = self.__export(target = f, encounter = encounter, soap_cats = soap_cats)
                f.close()

                if export_to_import_file:
                        # detect "LW:\medistar\inst\soap.txt"
                        medistar_found = False
                        for drive in 'cdefghijklmnopqrstuvwxyz':
                                path = drive + ':\\medistar\\inst'
                                if not os.path.isdir(path):
                                        continue
                                try:
                                        import_fname = path + '\\soap.txt'
                                        open(import_fname, mode = 'w+b').close()
                                        _log.debug('exporting narrative to [%s] for Medistar import', import_fname)
                                        shutil.copyfile(filename, import_fname)
                                        medistar_found = True
                                except IOError:
                                        continue

                        if not medistar_found:
                                _log.debug('no Medistar installation found (no <LW>:\\medistar\\inst\\)')

                return (status, filename)
        #--------------------------------------------------------
        def export(self, target, encounter=None, soap_cats='soapu'):
                return self.__export(target, encounter = encounter, soap_cats = soap_cats)
        #--------------------------------------------------------
        # interal API
        #--------------------------------------------------------
        def __export(self, target=None, encounter=None, soap_cats='soapu'):
                # get data
                cmd = "select narrative from clin.v_emr_journal where pk_patient=%s and pk_encounter=%s and soap_cat=%s"
                for soap_cat in soap_cats:
                        rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': (self.__pat['pk_identity'], encounter['pk_encounter'], soap_cat)}])
                        target.write('*MD%s*\r\n' % gmSoapDefs.soap_cat2l10n[soap_cat])
                        for row in rows:
                                text = row[0]
                                if text is None:
                                        continue
                                target.write('%s\r\n' % gmTools.wrap (
                                        text = text,
                                        width = 64,
                                        eol = '\r\n'
                                ))
                return True

Methods

def export(self, target, encounter=None, soap_cats='soapu')
Expand source code
def export(self, target, encounter=None, soap_cats='soapu'):
        return self.__export(target, encounter = encounter, soap_cats = soap_cats)
def save_to_file(self, filename=None, encounter=None, soap_cats='soapu', export_to_import_file=False)
Expand source code
def save_to_file(self, filename=None, encounter=None, soap_cats='soapu', export_to_import_file=False):
        if not self.__pat.connected:
                return (False, 'no active patient')

        if filename is None:
                path = os.path.abspath(os.path.expanduser('~/gnumed/export'))
                filename = '%s-%s-%s-%s-%s.txt' % (
                        os.path.join(path, 'Medistar-MD'),
                        time.strftime('%Y-%m-%d',time.localtime()),
                        self.__pat['lastnames'].replace(' ', '-'),
                        self.__pat['firstnames'].replace(' ', '_'),
                        self.__pat.get_formatted_dob(format = '%Y-%m-%d')
                )

        f = open(filename, mode = 'w+t', encoding = 'cp437', errors='replace')
        status = self.__export(target = f, encounter = encounter, soap_cats = soap_cats)
        f.close()

        if export_to_import_file:
                # detect "LW:\medistar\inst\soap.txt"
                medistar_found = False
                for drive in 'cdefghijklmnopqrstuvwxyz':
                        path = drive + ':\\medistar\\inst'
                        if not os.path.isdir(path):
                                continue
                        try:
                                import_fname = path + '\\soap.txt'
                                open(import_fname, mode = 'w+b').close()
                                _log.debug('exporting narrative to [%s] for Medistar import', import_fname)
                                shutil.copyfile(filename, import_fname)
                                medistar_found = True
                        except IOError:
                                continue

                if not medistar_found:
                        _log.debug('no Medistar installation found (no <LW>:\\medistar\\inst\\)')

        return (status, filename)