File: gmFamilyHistory.html

package info (click to toggle)
gnumed-client 1.8.21%2Bdfsg-1
links: PTS, VCS
area: main
in suites: forky, sid, trixie
size: 37,764 kB
sloc: python: 126,692; javascript: 6,113; sh: 1,195; xml: 36; makefile: 33
file content (888 lines) | stat: -rw-r--r-- 46,257 bytes
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>Gnumed.business.gmFamilyHistory API documentation</title>
<meta name="description" content="GNUmed family history handling middleware" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>Gnumed.business.gmFamilyHistory</code></h1>
</header>
<section id="section-intro">
<p>GNUmed family history handling middleware</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;GNUmed family history handling middleware&#34;&#34;&#34;
#============================================================
__license__ = &#34;GPL&#34;
__author__ = &#34;K.Hilbert &lt;Karsten.Hilbert@gmx.net&gt;&#34;


# stdlib
import sys, logging


# GNUmed modules
if __name__ == &#39;__main__&#39;:
        sys.path.insert(0, &#39;../../&#39;)
        _ = lambda x:x
from Gnumed.pycommon import gmPG2
from Gnumed.pycommon import gmBusinessDBObject
from Gnumed.pycommon import gmDateTime
from Gnumed.pycommon import gmTools

from Gnumed.business import gmCoding


_log = logging.getLogger(&#39;gm.fhx&#39;)

#============================================================
# relationship type handling
#------------------------------------------------------------
def create_relationship_type(relationship=None, genetic=None):

        args = {&#39;rel&#39;: relationship, &#39;gen&#39;: genetic}

        # already exists ?
        cmd = &#34;&#34;&#34;
                SELECT *, _(description) as l10n_description
                FROM clin.fhx_relation_type
                WHERE
                        description = %(rel)s
                                OR
                        _(description) = %(rel)s
        &#34;&#34;&#34;
        rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        if len(rows) &gt; 0:
                return rows[0]

        # create it
        cmd = &#34;&#34;&#34;
                INSERT INTO clin.fhx_relation_type (
                        description,
                        is_genetic
                ) VALUES (
                        i18n.i18n(gm.nullify_empty_string(%(rel)s)),
                        %(gen)s
                )
                RETURNING *
        &#34;&#34;&#34;
        rows = gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}], return_data = True)
        return rows[0]

#============================================================
# Family History item handling
#------------------------------------------------------------
_SQL_get_family_history = &#34;SELECT * from clin.v_family_history WHERE %s&#34;

class cFamilyHistory(gmBusinessDBObject.cBusinessDBObject):
        &#34;&#34;&#34;Represents a Family History item.&#34;&#34;&#34;

        _cmd_fetch_payload = _SQL_get_family_history % &#34;pk_family_history = %s&#34;
        _cmds_store_payload = [
                &#34;&#34;&#34;
                        UPDATE clin.family_history SET
                                narrative = gm.nullify_empty_string(%(condition)s),
                                age_noted = gm.nullify_empty_string(%(age_noted)s),
                                age_of_death = %(age_of_death)s,
                                contributed_to_death = %(contributed_to_death)s,
                                clin_when = %(when_known_to_patient)s,
                                name_relative = gm.nullify_empty_string(%(name_relative)s),
                                dob_relative = %(dob_relative)s,
                                comment = gm.nullify_empty_string(%(comment)s),
                                fk_episode = %(pk_episode)s,
                                fk_relation_type = %(pk_fhx_relation_type)s
                        WHERE
                                pk = %(pk_family_history)s
                                        AND
                                xmin = %(xmin_family_history)s
                        RETURNING
                                pk as pk_family_history,
                                xmin as xmin_family_history
                &#34;&#34;&#34;
        ]
        # view columns that can be updated:
        _updatable_fields = [
                &#39;condition&#39;,
                &#39;age_noted&#39;,
                &#39;age_of_death&#39;,
                &#39;contributed_to_death&#39;,
                &#39;when_known_to_patient&#39;,
                &#39;name_relative&#39;,
                &#39;dob_relative&#39;,
                &#39;pk_encounter&#39;,
                &#39;pk_episode&#39;,
                &#39;pk_fhx_relation_type&#39;,
                &#39;comment&#39;
        ]

        #--------------------------------------------------------
        def add_code(self, pk_code=None):
                &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;

                if pk_code in self._payload[&#39;pk_generic_codes&#39;]:
                        return

                cmd = &#34;&#34;&#34;
                        INSERT INTO clin.lnk_code2fhx
                                (fk_item, fk_generic_code)
                        SELECT
                                %(item)s,
                                %(code)s
                        WHERE NOT EXISTS (
                                SELECT 1 FROM clin.lnk_code2fhx
                                WHERE
                                        fk_item = %(item)s
                                                AND
                                        fk_generic_code = %(code)s
                        )&#34;&#34;&#34;
                args = {
                        &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                        &#39;code&#39;: pk_code
                }
                gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return

        #--------------------------------------------------------
        def remove_code(self, pk_code=None):
                &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;
                cmd = &#34;DELETE FROM clin.lnk_code2fhx WHERE fk_item = %(item)s AND fk_generic_code = %(code)s&#34;
                args = {
                        &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                        &#39;code&#39;: pk_code
                }
                gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return True

        #--------------------------------------------------------
        def format_maximum_information(self, patient=None):

                # include more fields from clin.v_family_history

                return self.format (
                        include_episode = True,
                        include_comment = True,
                        include_codes = True
                ).split(&#39;\n&#39;)

        #--------------------------------------------------------
        def format(self, left_margin=0, include_episode=False, include_comment=False, include_codes=False):

                line = &#39;%s%s&#39; % (
                        (&#39; &#39; * left_margin),
                        self._payload[&#39;l10n_relation&#39;]
                )
                if self._payload[&#39;age_of_death&#39;] is not None:
                        line += &#39; (%s %s)&#39; % (
                                gmTools.u_latin_cross,
                                gmDateTime.format_interval_medically(self._payload[&#39;age_of_death&#39;])
                        )
                line += &#39;: %s&#39; % self._payload[&#39;condition&#39;]
                if self._payload[&#39;age_noted&#39;] is not None:
                        line += gmTools.coalesce(self._payload[&#39;age_noted&#39;], &#39;&#39;, &#39; (@ %s)&#39;)
                if self._payload[&#39;contributed_to_death&#39;]:
                        line += &#39; %s %s&#39; % (
                                gmTools.u_arrow2right,
                                gmTools.u_skull_and_crossbones
                        )

                if include_episode:
                        line += &#39;\n%s  %s: %s&#39; % (
                                (&#39; &#39; * left_margin),
                                _(&#39;Episode&#39;),
                                self._payload[&#39;episode&#39;]
                        )

                if include_comment:
                        if self._payload[&#39;comment&#39;] is not None:
                                line += &#39;\n%s  %s&#39; % (
                                        (&#39; &#39; * left_margin),
                                        self._payload[&#39;comment&#39;]
                                )

                if include_codes:
                        codes = self.generic_codes
                        if len(codes) &gt; 0:
                                line += &#39;\n&#39;
                        for c in codes:
                                line += &#39;%s  %s: %s (%s - %s)\n&#39; % (
                                        (&#39; &#39; * left_margin),
                                        c[&#39;code&#39;],
                                        c[&#39;term&#39;],
                                        c[&#39;name_short&#39;],
                                        c[&#39;version&#39;]
                                )
                        del codes

                return line

        #--------------------------------------------------------
        # properties
        #--------------------------------------------------------
        def _get_generic_codes(self):
                if len(self._payload[&#39;pk_generic_codes&#39;]) == 0:
                        return []

                cmd = gmCoding._SQL_get_generic_linked_codes % &#39;pk_generic_code = ANY(%(pks)s)&#39;
                args = {&#39;pks&#39;: self._payload[&#39;pk_generic_codes&#39;]}
                rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return [ gmCoding.cGenericLinkedCode(row = {&#39;data&#39;: r, &#39;pk_field&#39;: &#39;pk_lnk_code2item&#39;}) for r in rows ]

        def _set_generic_codes(self, pk_codes):
                queries = []
                # remove all codes
                if len(self._payload[&#39;pk_generic_codes&#39;]) &gt; 0:
                        queries.append ({
                                &#39;cmd&#39;: &#39;DELETE FROM clin.lnk_code2fhx WHERE fk_item = %(fhx)s AND fk_generic_code = ANY(%(codes)s)&#39;,
                                &#39;args&#39;: {
                                        &#39;fhx&#39;: self._payload[&#39;pk_family_history&#39;],
                                        &#39;codes&#39;: self._payload[&#39;pk_generic_codes&#39;]
                                }
                        })
                # add new codes
                for pk_code in pk_codes:
                        queries.append ({
                                &#39;cmd&#39;: &#39;INSERT INTO clin.lnk_code2fhx (fk_item, fk_generic_code) VALUES (%(fhx)s, %(pk_code)s)&#39;,
                                &#39;args&#39;: {
                                        &#39;fhx&#39;: self._payload[&#39;pk_family_history&#39;],
                                        &#39;pk_code&#39;: pk_code
                                }
                        })
                if len(queries) == 0:
                        return
                # run it all in one transaction
                gmPG2.run_rw_queries(queries = queries)
                return

        generic_codes = property(_get_generic_codes, _set_generic_codes)
#------------------------------------------------------------
def get_family_history(order_by=None, patient=None):

        args = {}
        where_parts = []

        if patient is not None:
                where_parts.append(&#39;pk_patient = %(pat)s&#39;)
                args[&#39;pat&#39;] = patient

        if order_by is None:
                if len(where_parts) == 0:
                        order_by = &#39;true&#39;
                else:
                        order_by = &#39;&#39;
        else:
                if len(where_parts) == 0:
                        order_by = &#39;true ORDER BY %s&#39; % order_by
                else:
                        order_by = &#39;ORDER BY %s&#39; % order_by

        cmd = _SQL_get_family_history % &#39; AND &#39;.join(where_parts) + &#39; &#39; + order_by
        rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return [ cFamilyHistory(row = {&#39;data&#39;: r, &#39;pk_field&#39;: &#39;pk_family_history&#39;}) for r in rows ]

#------------------------------------------------------------
def create_family_history(encounter=None, episode=None, condition=None, relation=None):

        args = {
                &#39;enc&#39;: encounter,
                &#39;epi&#39;: episode,
                &#39;cond&#39;: condition,
                &#39;rel&#39;: relation
        }
        cmd = &#34;&#34;&#34;
                INSERT INTO clin.family_history (
                        soap_cat,
                        fk_encounter,
                        fk_episode,
                        narrative,
                        fk_relation_type
                ) VALUES (
                        &#39;s&#39;::text,
                        %(enc)s,
                        %(epi)s,
                        gm.nullify_empty_string(%(cond)s),
                        %(rel)s
                )
                RETURNING pk
        &#34;&#34;&#34;
        rows = gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}], return_data = True)

        return cFamilyHistory(aPK_obj = rows[0][&#39;pk&#39;])
#------------------------------------------------------------
def delete_family_history(pk_family_history=None):
        args = {&#39;pk&#39;: pk_family_history}
        cmd = &#34;DELETE FROM clin.family_history WHERE pk = %(pk)s&#34;
        gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return True
#============================================================
# main
#------------------------------------------------------------
if __name__ == &#34;__main__&#34;:

        if len(sys.argv) &lt; 2:
                sys.exit()

        if sys.argv[1] != &#39;test&#39;:
                sys.exit()

        #----------------------------------------------------
        def test_get_fhx():
                print(&#34;family history:&#34;)
                for fhx in get_family_history():
                        print(fhx)
        #----------------------------------------------------
        test_get_fhx()

#============================================================</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="Gnumed.business.gmFamilyHistory.create_family_history"><code class="name flex">
<span>def <span class="ident">create_family_history</span></span>(<span>encounter=None, episode=None, condition=None, relation=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_family_history(encounter=None, episode=None, condition=None, relation=None):

        args = {
                &#39;enc&#39;: encounter,
                &#39;epi&#39;: episode,
                &#39;cond&#39;: condition,
                &#39;rel&#39;: relation
        }
        cmd = &#34;&#34;&#34;
                INSERT INTO clin.family_history (
                        soap_cat,
                        fk_encounter,
                        fk_episode,
                        narrative,
                        fk_relation_type
                ) VALUES (
                        &#39;s&#39;::text,
                        %(enc)s,
                        %(epi)s,
                        gm.nullify_empty_string(%(cond)s),
                        %(rel)s
                )
                RETURNING pk
        &#34;&#34;&#34;
        rows = gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}], return_data = True)

        return cFamilyHistory(aPK_obj = rows[0][&#39;pk&#39;])</code></pre>
</details>
</dd>
<dt id="Gnumed.business.gmFamilyHistory.create_relationship_type"><code class="name flex">
<span>def <span class="ident">create_relationship_type</span></span>(<span>relationship=None, genetic=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_relationship_type(relationship=None, genetic=None):

        args = {&#39;rel&#39;: relationship, &#39;gen&#39;: genetic}

        # already exists ?
        cmd = &#34;&#34;&#34;
                SELECT *, _(description) as l10n_description
                FROM clin.fhx_relation_type
                WHERE
                        description = %(rel)s
                                OR
                        _(description) = %(rel)s
        &#34;&#34;&#34;
        rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        if len(rows) &gt; 0:
                return rows[0]

        # create it
        cmd = &#34;&#34;&#34;
                INSERT INTO clin.fhx_relation_type (
                        description,
                        is_genetic
                ) VALUES (
                        i18n.i18n(gm.nullify_empty_string(%(rel)s)),
                        %(gen)s
                )
                RETURNING *
        &#34;&#34;&#34;
        rows = gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}], return_data = True)
        return rows[0]</code></pre>
</details>
</dd>
<dt id="Gnumed.business.gmFamilyHistory.delete_family_history"><code class="name flex">
<span>def <span class="ident">delete_family_history</span></span>(<span>pk_family_history=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def delete_family_history(pk_family_history=None):
        args = {&#39;pk&#39;: pk_family_history}
        cmd = &#34;DELETE FROM clin.family_history WHERE pk = %(pk)s&#34;
        gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return True</code></pre>
</details>
</dd>
<dt id="Gnumed.business.gmFamilyHistory.get_family_history"><code class="name flex">
<span>def <span class="ident">get_family_history</span></span>(<span>order_by=None, patient=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_family_history(order_by=None, patient=None):

        args = {}
        where_parts = []

        if patient is not None:
                where_parts.append(&#39;pk_patient = %(pat)s&#39;)
                args[&#39;pat&#39;] = patient

        if order_by is None:
                if len(where_parts) == 0:
                        order_by = &#39;true&#39;
                else:
                        order_by = &#39;&#39;
        else:
                if len(where_parts) == 0:
                        order_by = &#39;true ORDER BY %s&#39; % order_by
                else:
                        order_by = &#39;ORDER BY %s&#39; % order_by

        cmd = _SQL_get_family_history % &#39; AND &#39;.join(where_parts) + &#39; &#39; + order_by
        rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return [ cFamilyHistory(row = {&#39;data&#39;: r, &#39;pk_field&#39;: &#39;pk_family_history&#39;}) for r in rows ]</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="Gnumed.business.gmFamilyHistory.cFamilyHistory"><code class="flex name class">
<span>class <span class="ident">cFamilyHistory</span></span>
<span>(</span><span>aPK_obj: int | dict = None, row: dict = None, link_obj=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Represents a Family History item.</p>
<p>Call <strong>init</strong> from child classes like so:</p>
<pre><code>    super().__init__(aPK_obj = aPK_obj, row = row, link_obj = link_obj)
</code></pre>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>aPK_obj</code></strong></dt>
<dd>retrieve data from backend</dd>
</dl>
<ul>
<li>an scalar value
the ._cmd_fetch_payload WHERE condition must be a simple column: "&hellip; WHERE pk_col = %s"</li>
<li>a dictionary of values
the ._cmd_fetch_payload WHERE condition must consume the
dictionary and produce a unique row</li>
</ul>
<dl>
<dt><strong><code>row</code></strong></dt>
<dd>must hold the fields</dd>
</dl>
<ul>
<li>data: list of column values for the row selected by ._cmd_fetch_payload (as returned by cursor.fetchone() in the DB-API)</li>
<li>pk_field: the name of the primary key column
OR</li>
<li>pk_obj: a dictionary suitable for being passed to cursor.execute
and holding the primary key values, used for composite PKs</li>
<li>for example:<pre><code>row = {
        'data': rows[0],
        'pk_field': 'pk_XXX (the PK column name)',
        'pk_obj': {'pk_col1': pk_col1_val, 'pk_col2': pk_col2_val}
}

rows = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': args}])
objects = [ cChildClass(row = {'data': r, 'pk_field': 'the PK column name'}) for r in rows ]
</code></pre>
</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class cFamilyHistory(gmBusinessDBObject.cBusinessDBObject):
        &#34;&#34;&#34;Represents a Family History item.&#34;&#34;&#34;

        _cmd_fetch_payload = _SQL_get_family_history % &#34;pk_family_history = %s&#34;
        _cmds_store_payload = [
                &#34;&#34;&#34;
                        UPDATE clin.family_history SET
                                narrative = gm.nullify_empty_string(%(condition)s),
                                age_noted = gm.nullify_empty_string(%(age_noted)s),
                                age_of_death = %(age_of_death)s,
                                contributed_to_death = %(contributed_to_death)s,
                                clin_when = %(when_known_to_patient)s,
                                name_relative = gm.nullify_empty_string(%(name_relative)s),
                                dob_relative = %(dob_relative)s,
                                comment = gm.nullify_empty_string(%(comment)s),
                                fk_episode = %(pk_episode)s,
                                fk_relation_type = %(pk_fhx_relation_type)s
                        WHERE
                                pk = %(pk_family_history)s
                                        AND
                                xmin = %(xmin_family_history)s
                        RETURNING
                                pk as pk_family_history,
                                xmin as xmin_family_history
                &#34;&#34;&#34;
        ]
        # view columns that can be updated:
        _updatable_fields = [
                &#39;condition&#39;,
                &#39;age_noted&#39;,
                &#39;age_of_death&#39;,
                &#39;contributed_to_death&#39;,
                &#39;when_known_to_patient&#39;,
                &#39;name_relative&#39;,
                &#39;dob_relative&#39;,
                &#39;pk_encounter&#39;,
                &#39;pk_episode&#39;,
                &#39;pk_fhx_relation_type&#39;,
                &#39;comment&#39;
        ]

        #--------------------------------------------------------
        def add_code(self, pk_code=None):
                &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;

                if pk_code in self._payload[&#39;pk_generic_codes&#39;]:
                        return

                cmd = &#34;&#34;&#34;
                        INSERT INTO clin.lnk_code2fhx
                                (fk_item, fk_generic_code)
                        SELECT
                                %(item)s,
                                %(code)s
                        WHERE NOT EXISTS (
                                SELECT 1 FROM clin.lnk_code2fhx
                                WHERE
                                        fk_item = %(item)s
                                                AND
                                        fk_generic_code = %(code)s
                        )&#34;&#34;&#34;
                args = {
                        &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                        &#39;code&#39;: pk_code
                }
                gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return

        #--------------------------------------------------------
        def remove_code(self, pk_code=None):
                &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;
                cmd = &#34;DELETE FROM clin.lnk_code2fhx WHERE fk_item = %(item)s AND fk_generic_code = %(code)s&#34;
                args = {
                        &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                        &#39;code&#39;: pk_code
                }
                gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return True

        #--------------------------------------------------------
        def format_maximum_information(self, patient=None):

                # include more fields from clin.v_family_history

                return self.format (
                        include_episode = True,
                        include_comment = True,
                        include_codes = True
                ).split(&#39;\n&#39;)

        #--------------------------------------------------------
        def format(self, left_margin=0, include_episode=False, include_comment=False, include_codes=False):

                line = &#39;%s%s&#39; % (
                        (&#39; &#39; * left_margin),
                        self._payload[&#39;l10n_relation&#39;]
                )
                if self._payload[&#39;age_of_death&#39;] is not None:
                        line += &#39; (%s %s)&#39; % (
                                gmTools.u_latin_cross,
                                gmDateTime.format_interval_medically(self._payload[&#39;age_of_death&#39;])
                        )
                line += &#39;: %s&#39; % self._payload[&#39;condition&#39;]
                if self._payload[&#39;age_noted&#39;] is not None:
                        line += gmTools.coalesce(self._payload[&#39;age_noted&#39;], &#39;&#39;, &#39; (@ %s)&#39;)
                if self._payload[&#39;contributed_to_death&#39;]:
                        line += &#39; %s %s&#39; % (
                                gmTools.u_arrow2right,
                                gmTools.u_skull_and_crossbones
                        )

                if include_episode:
                        line += &#39;\n%s  %s: %s&#39; % (
                                (&#39; &#39; * left_margin),
                                _(&#39;Episode&#39;),
                                self._payload[&#39;episode&#39;]
                        )

                if include_comment:
                        if self._payload[&#39;comment&#39;] is not None:
                                line += &#39;\n%s  %s&#39; % (
                                        (&#39; &#39; * left_margin),
                                        self._payload[&#39;comment&#39;]
                                )

                if include_codes:
                        codes = self.generic_codes
                        if len(codes) &gt; 0:
                                line += &#39;\n&#39;
                        for c in codes:
                                line += &#39;%s  %s: %s (%s - %s)\n&#39; % (
                                        (&#39; &#39; * left_margin),
                                        c[&#39;code&#39;],
                                        c[&#39;term&#39;],
                                        c[&#39;name_short&#39;],
                                        c[&#39;version&#39;]
                                )
                        del codes

                return line

        #--------------------------------------------------------
        # properties
        #--------------------------------------------------------
        def _get_generic_codes(self):
                if len(self._payload[&#39;pk_generic_codes&#39;]) == 0:
                        return []

                cmd = gmCoding._SQL_get_generic_linked_codes % &#39;pk_generic_code = ANY(%(pks)s)&#39;
                args = {&#39;pks&#39;: self._payload[&#39;pk_generic_codes&#39;]}
                rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
                return [ gmCoding.cGenericLinkedCode(row = {&#39;data&#39;: r, &#39;pk_field&#39;: &#39;pk_lnk_code2item&#39;}) for r in rows ]

        def _set_generic_codes(self, pk_codes):
                queries = []
                # remove all codes
                if len(self._payload[&#39;pk_generic_codes&#39;]) &gt; 0:
                        queries.append ({
                                &#39;cmd&#39;: &#39;DELETE FROM clin.lnk_code2fhx WHERE fk_item = %(fhx)s AND fk_generic_code = ANY(%(codes)s)&#39;,
                                &#39;args&#39;: {
                                        &#39;fhx&#39;: self._payload[&#39;pk_family_history&#39;],
                                        &#39;codes&#39;: self._payload[&#39;pk_generic_codes&#39;]
                                }
                        })
                # add new codes
                for pk_code in pk_codes:
                        queries.append ({
                                &#39;cmd&#39;: &#39;INSERT INTO clin.lnk_code2fhx (fk_item, fk_generic_code) VALUES (%(fhx)s, %(pk_code)s)&#39;,
                                &#39;args&#39;: {
                                        &#39;fhx&#39;: self._payload[&#39;pk_family_history&#39;],
                                        &#39;pk_code&#39;: pk_code
                                }
                        })
                if len(queries) == 0:
                        return
                # run it all in one transaction
                gmPG2.run_rw_queries(queries = queries)
                return

        generic_codes = property(_get_generic_codes, _set_generic_codes)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject">cBusinessDBObject</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="Gnumed.business.gmFamilyHistory.cFamilyHistory.generic_codes"><code class="name">var <span class="ident">generic_codes</span></code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def _get_generic_codes(self):
        if len(self._payload[&#39;pk_generic_codes&#39;]) == 0:
                return []

        cmd = gmCoding._SQL_get_generic_linked_codes % &#39;pk_generic_code = ANY(%(pks)s)&#39;
        args = {&#39;pks&#39;: self._payload[&#39;pk_generic_codes&#39;]}
        rows = gmPG2.run_ro_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return [ gmCoding.cGenericLinkedCode(row = {&#39;data&#39;: r, &#39;pk_field&#39;: &#39;pk_lnk_code2item&#39;}) for r in rows ]</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="Gnumed.business.gmFamilyHistory.cFamilyHistory.add_code"><code class="name flex">
<span>def <span class="ident">add_code</span></span>(<span>self, pk_code=None)</span>
</code></dt>
<dd>
<div class="desc"><p><pk_code> must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_code(self, pk_code=None):
        &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;

        if pk_code in self._payload[&#39;pk_generic_codes&#39;]:
                return

        cmd = &#34;&#34;&#34;
                INSERT INTO clin.lnk_code2fhx
                        (fk_item, fk_generic_code)
                SELECT
                        %(item)s,
                        %(code)s
                WHERE NOT EXISTS (
                        SELECT 1 FROM clin.lnk_code2fhx
                        WHERE
                                fk_item = %(item)s
                                        AND
                                fk_generic_code = %(code)s
                )&#34;&#34;&#34;
        args = {
                &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                &#39;code&#39;: pk_code
        }
        gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return</code></pre>
</details>
</dd>
<dt id="Gnumed.business.gmFamilyHistory.cFamilyHistory.format_maximum_information"><code class="name flex">
<span>def <span class="ident">format_maximum_information</span></span>(<span>self, patient=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def format_maximum_information(self, patient=None):

        # include more fields from clin.v_family_history

        return self.format (
                include_episode = True,
                include_comment = True,
                include_codes = True
        ).split(&#39;\n&#39;)</code></pre>
</details>
</dd>
<dt id="Gnumed.business.gmFamilyHistory.cFamilyHistory.remove_code"><code class="name flex">
<span>def <span class="ident">remove_code</span></span>(<span>self, pk_code=None)</span>
</code></dt>
<dd>
<div class="desc"><p><pk_code> must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_code(self, pk_code=None):
        &#34;&#34;&#34;&lt;pk_code&gt; must be a value from ref.coding_system_root.pk_coding_system (clin.lnk_code2item_root.fk_generic_code)&#34;&#34;&#34;
        cmd = &#34;DELETE FROM clin.lnk_code2fhx WHERE fk_item = %(item)s AND fk_generic_code = %(code)s&#34;
        args = {
                &#39;item&#39;: self._payload[&#39;pk_family_history&#39;],
                &#39;code&#39;: pk_code
        }
        gmPG2.run_rw_queries(queries = [{&#39;cmd&#39;: cmd, &#39;args&#39;: args}])
        return True</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject">cBusinessDBObject</a></b></code>:
<ul class="hlist">
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.fields_as_dict" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.fields_as_dict">fields_as_dict</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.format" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.format">format</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_fields" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_fields">get_fields</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_patient" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_patient">get_patient</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_updatable_fields" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.get_updatable_fields">get_updatable_fields</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.is_modified" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.is_modified">is_modified</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.keys" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.keys">keys</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.patient_pk" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.patient_pk">patient_pk</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.refetch_payload" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.refetch_payload">refetch_payload</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.same_payload" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.same_payload">same_payload</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.save" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.save">save</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.save_payload" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.save_payload">save_payload</a></code></li>
<li><code><a title="Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.staff_id" href="gmBusinessDBObject.html#Gnumed.pycommon.gmBusinessDBObject.cBusinessDBObject.staff_id">staff_id</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="Gnumed.business" href="http://www.gnumed.de/downloads/docs/api/business/index.html">Gnumed.business</a></code></li>
</ul>
</li>
<li><h3><a href="gmFamilyHistory.html#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="Gnumed.business.gmFamilyHistory.create_family_history" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.create_family_history">create_family_history</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.create_relationship_type" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.create_relationship_type">create_relationship_type</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.delete_family_history" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.delete_family_history">delete_family_history</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.get_family_history" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.get_family_history">get_family_history</a></code></li>
</ul>
</li>
<li><h3><a href="gmFamilyHistory.html#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="Gnumed.business.gmFamilyHistory.cFamilyHistory" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.cFamilyHistory">cFamilyHistory</a></code></h4>
<ul class="">
<li><code><a title="Gnumed.business.gmFamilyHistory.cFamilyHistory.add_code" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.cFamilyHistory.add_code">add_code</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.cFamilyHistory.format_maximum_information" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.cFamilyHistory.format_maximum_information">format_maximum_information</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.cFamilyHistory.generic_codes" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.cFamilyHistory.generic_codes">generic_codes</a></code></li>
<li><code><a title="Gnumed.business.gmFamilyHistory.cFamilyHistory.remove_code" href="gmFamilyHistory.html#Gnumed.business.gmFamilyHistory.cFamilyHistory.remove_code">remove_code</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>