Changes between Version 9 and Version 10 of Documentatie/Beheerder/Modules/Decursus

Timestamp:

05/08/13 12:26:11 (13 years ago)

Author:

adriaan

Comment:

--

Documentatie/Beheerder/Modules/Decursus

@@ -7 +7 @@
 Dit hoofdstuk beschrijft het naar eigen wensen inrichten van de decursusmodule.
 
-== Thema's ==
+== Decursus Gegevens ==
+
+Ongeacht de manier waarop decursus verder wordt ingericht of vormgegeven
+binnen OpenAC heeft een decursus-aantekening een aantal gegevens nodig.
+Decursus wordt ingedeeld in '''thema's'''. De verschillende thema's vullen
+decursus '''velden''' in; daar staan de gegevens die relevant zijn voor dat thema.
+Om het aanmaken van standaardbrieven te ondersteunen zijn er ook standaard
+'''briefteksten''' en '''testscores'''(-vermeldingen). Tot slot is de '''layout''' van de
+decursus-entry (de weergave in het dossier) nauwkeurig in te richten.
+
+=== Thema's ===
 
 [[Image(decursusthema2.png, class=inline-right)]]Decursus thema's kunnen worden toegevoegd via (beheer)scherm ''Codetabellen'' --> Module kern.s080_decursus --> Thema. Nieuw ingevoerde thema's kunnen gelijk gebruikt worden. De invoervelden die standaard horen bij een nieuw thema zijn:
@@ -18 +28 @@
 Het decursusthema is te kiezen in het decursusblok in het patientendossier. De omschrijvingen van die thema's die in gebruik zijn, worden getoond, zoals in het screenshot hiernaast. De thema's worden op volgnummer gesorteerd, niet alfabetisch.
 
-== Velden ==
+=== Velden ===
 
 Een decursus-entry heeft standaard een groot aantal velden. Deze zijn gedefinieerd in de module `s080_decursus`. Niet alle velden zijn in alle thema's van toepassing, en worden dan onzichtbaar gemaakt.
@@ -40 +50 @@
 De velden in een cursusentry worden opgeslagen in de structuur-bestanden van OpenAC. Het is aan te bevelen wijzigingen in te leveren na het toevoegen van een veld. Gebruikers zullen moeten schakelen.
 
-== Thema-Engine ==
-
-Omdat velden niet voor alle thema's van toepassing zijn, kan de layout van een decursus-entry aangepast worden per thema. De meest eenvoudige manier om dat te doen maakt gebruik van een ''thema-engine''. Deze wordt in het adaptatie-script ingesteld. De thema-engine maakt velden zichtbaar of onzichtbaar al naar gelang het gekozen thema.
-
-Als een veld slechts in enkele thema's zichtbaar hoeft te zijn, is het aan te bevelen het in de layout van de tabel `cursusentry` juist '''onzichtbaar''' te maken; dan laten we aan de thema-engine over om het zichtbaar te maken. Net zo kunnen we bij een veld dat meestal zichtbaar moet zijn (maar in enkele gevallen niet) het veld het beste een layout geven, en dan de thema-engine het laten verhullen als het niet nodig is.
-
-Documentatie over het gebruik van de thema-engine is te vinden in de broncode van [browser:/development/kern/s080_decursus/themaengine.py]. In de adaptatie-script wordt een thema gekoppeld aan gewenste effecten op de layout van de velden met code als deze:
-
-{{{
-        themaengine.registreer_thema(
-            "uitbehandeld",
-            layout={
-                "uitbehandelingsreden" : "2:8x3",
-                "anamnese" : "-"
-            })
-}}}
-
-Het effect van zo'n thema met layout-wijzigingen is dat een thema "uitbehandeld" een eigen veld met codetabel kan krijgen, dat alleen zichtbaar is in dat thema, zoals in het screenshot hieronder.
-
-[[Image(decursusthema3.png)]]
-
-
-== Briefteksten ==
+=== Briefteksten ===
+
 Briefteksten zijn standaardteksten die horen bij een thema. Ze worden in OpenAC gepresenteerd in een zogenaamde sidebar. Van daaruit kunnen de briefteksten worden ingevoegd in een bijbehorend invoerveld. Briefteksten kunnen worden ingevoerd via codetabellen --> Module kern.s080_decursus --> Brief-tekstfragment. Het invoerscherm kent de volgende velden:
  * Brief-tekstfragment. Dit is de code die de brieftekst identificeert. In sidebars worden briefteksten gegroepeerd op code, met een visuele scheiding tussen de groepen. Dus alle codes die beginnen met een S worden bijelkaar gezet, codes beginnend met een T ook, etc.
@@ -71 +60 @@
  * Tekst: De eigenlijke brieftekst. De variabelen {patient} en {leeftijd} zijn beschikbaar en worden tijdens het invoegen van de tekst vervangen door de naam en leeftijd van de patient. 
 
-== Testscores ==
+=== Testscores ===
+
 Testscores zijn briefteksten die in de sidebar zijn voorzien van een invoerveld om een testscore in te voeren. Ze kunnen in hetzelfde scherm worden ingevoerd als briefteksten, maar in tegenstelling tot briefteksten moet bij testscores de optie Scoreveld op "ja" worden gezet. In de tekst van testscores kunnen buiten {patient} en {leeftijd} ook de variabelen {test}, {beoordeling} en {score} worden gebruikt. Deze worden bij het invoegen van de tekst vervangen door de overeenkomstige waarden.
 
 Een belangrijke aanvullende voorwaarde voor het correct functioneren van de testscorefunctionaliteit, is dat de code van de testscore exact gelijk moet zijn aan de decursus veldnaam waar de score in moet worden opgeslagen.
 
-== Invoervelden ==
-
-[[NoteBox(tip, Deze informatie maakt het mogelijk om tot aan de kleinste details de layout en het gedrag van decursusentries aan te passen. Voor dagelijks gebruik is het gebruik van een thema-engine te prefereren.)]]
+=== Layout ===
+
+In de `structuur.tsv` file kan je een ''groep'' invullen (in de kolom ''box'') voor een veld en een ''layout''.
+Met de groep geef je aan hoe de velden in groepjes bij elkaar binnen de box vertoond worden. 
+Er komt een horizontale streep tussen de groepjes. In een gewoon decursus-entry heb je drie
+groepen, bovenaan de datum en het thema, dan een boel velden en onderaan de documenten-selector.
+Door in de structuur tabel te kijken zie je dat de groepen nummers 1, 2 en 8 (bestanden) hebben.
+
+Binnen een groep kan je een veld een volgnummer geven. Het veld wordt dan met dat volgnummer vertoond;
+velden met hetzelfde volgnummer worden bij elkaar vertoond op volgorde van binnenkomst.
+
+Voor het aangeven van een groep en volgnummer, gebruik de notatie ''groep''[`.`''volgnummer'']: 
+het nummer van de groep, eventueel gevolgd door een punt (.) en een volgnummer. Hiermee kan je de
+'''plaats''' van een veld in een box helemaal vastleggen.
+
+De '''vormgeving''' van het veld wordt bepaald door de layout. Hiermee geef je aan hoe groot het
+label is voor het veld (in bijna alle boxen in OpenAC is dat 2) en hoe breed het veld zelf is
+(de volle breedte van een box is meestal 10, dus voor velden die de gehele breedte naast het label nemen
+schrijf je 8). Voor tekst-velden is het ook wel eens handig om ze meer dan een regel hoog te maken,
+zodat er meer tekst in te zien is. De notatie is ''labelbreedte''`:`''veldbreedte''[`x`''veldhoogte'']:
+de breedte van het label in vakjes (bijna altijd 2), een dubbele punt, dan de breedte van
+het veld (dikwijls 8), eventueel gevolgd door de letter `x` en dan de hoogte van het veld in regels.
+
+Een volledige plaats en vorm-bepaling van een veld kan er dus zo uit zien: `2.5 2:8x3`, te lezen als
+"in de tweede groep, het vijfde veld, met een label van 2 vakjes breed, en dan acht breed en drie
+regels hoog". Dat is een redelijk normale specificatie voor een tekstveld.
+
+De plaats kan alleen in de tabeldefinitie vastgelegd worden en is niet te veranderen
+tijdens het gebruik van OpenAC. De layout kan wel veranderd worden door in OpenAC
+van een entry de `meta.layouts` aan te passen. Dit wordt in de decursus-themaengine
+gedaan. De layout die je opgeeft aan de themaengine wordt toegepast -- zoals hierboven,
+schrijf je dan dingen als `2:8x3` in de layouts.
+
+== Thema-Engine ==
+
+Omdat velden niet voor alle thema's van toepassing zijn, kan de layout van een decursus-entry aangepast worden per thema. De meest eenvoudige manier om dat te doen maakt gebruik van een ''thema-engine''. Deze wordt in het adaptatie-script ingesteld. De thema-engine maakt velden zichtbaar of onzichtbaar al naar gelang het gekozen thema.
+
+Als een veld slechts in enkele thema's zichtbaar hoeft te zijn, is het aan te bevelen het in de layout van de tabel `cursusentry` juist '''onzichtbaar''' te maken; dan laten we aan de thema-engine over om het zichtbaar te maken. Net zo kunnen we bij een veld dat meestal zichtbaar moet zijn (maar in enkele gevallen niet) het veld het beste een layout geven, en dan de thema-engine het laten verhullen als het niet nodig is.
+
+Documentatie over het gebruik van de thema-engine is te vinden in de broncode van [browser:/development/kern/s080_decursus/themaengine.py]. In de adaptatie-script wordt een thema gekoppeld aan gewenste effecten op de layout van de velden met code als deze:
+
+{{{
+        themaengine.registreer_thema(
+            "uitbehandeld",
+            layout={
+                "uitbehandelingsreden" : "2:8x3",
+                "anamnese" : "-"
+            })
+}}}
+
+Het effect van zo'n thema met layout-wijzigingen is dat een thema "uitbehandeld" een eigen veld met codetabel kan krijgen, dat alleen zichtbaar is in dat thema, zoals in het screenshot hieronder.
+
+[[Image(decursusthema3.png)]]
+
+
+
+== Programmatisch Inrichten ==
+
+[[NoteBox(warn, Deze informatie maakt het mogelijk om tot aan de kleinste details de layout en het gedrag van decursusentries aan te passen. Voor dagelijks gebruik is het gebruik van een thema-engine te prefereren.)]]
 
 Zoals onder het kopje "Thema's" staat beschreven, is het aantal invoervelden bij een nieuw thema beperkt. Alle decursus invoervelden kunnen in principe bij elk thema worden gebruikt, eventueel voorzien van een ander label dan het default label. Om de standaardfunctionaliteit van de decursus module te wijzigen of uit te breiden, moet een stukje code worden geschreven in de eigen adaptatie. Het AMC is één van de AC's met een eigen decursus.py in de adaptatie.
@@ -144 +190 @@
 
 
-== Sidebars ==
+=== Sidebars ===
+
 Ook voor tonen van een sidebar bij een thema is wat code nodig in de eigen adaptatie. In dit geval gaat het om een opbouwfunctie die functionaliteit toevoegt aan de standaard decursus opbouwfunctie, en een functie die de sidebar implementeert. De opbouwfunctie:
 {{{
@@ -255 +302 @@
 }}}
 
-== FENAC ICT ==
+=== FENAC ICT ===
 Dit hoofdstuk laat zien dat het mogelijk is de decursus functionaliteit volledig naar eigen wensen in te richten. Natuurlijk kan FENAC ICT helpen met advies of implementatie.