Onkostar-Plugin zur Verwendung mit der DNPM-Formularsammlung

Die Formulare befinden sich im Verzeichnis /forms und liegen hier in gekürzter und sortierter Fassung einer OSC-Datei vor.

Zum Erstellen einer neuen Version der enthaltenen Datei(en) bitte den folgenden Befehl verwenden:

osc-variant modify --sorted --strip --output dnpm-formulare.osc <QUELLDATEI> 

Die für die Formulare verwendeten Formularscripte sind zudem im Verzeichnis `/scripts`` hinterlegt und können dort eingesehen werden.

Konfiguration

Dieses Plugin erlaubt die Konfiguration über Onkostar-Einstellungen. Hierzu gibt es die Konfigurationsparameter:

• constentform: Zu verwendendes Constent-Formular
• systemtherapieform: Zu verwendendes Formular für die systemische Therapie.
• mehrere_mtb_in_mtbepisode: Angabe, ob mehrere MTBs je MTB-Episode verwendet werden.

Achtung! Die Verwendung der Konfigurationskategorie DNPM ist für Onkostar-Versionen >=2.12.0 und <2.13.0 aufgrund einer Umstellung in der Darstellung der Konfiguration in Onkostar nicht möglich. Für Onkostar ab Version 2.13.0 (oder neuer) kann DNPM verwendet werden, für Versionen beginnend mit 2.12 sollte System verwendet werden.

ATC-Codes

Dieses Plugin integriert das ATC-Codes-Plugin vollständig. Dieses kann daher nicht zusätzlich in Onkostar installiert werden.

Consent

Das Plugin ist auf die Übernahme des DNPM-Consents ausgelegt. Hierzu muss die Einstellung consentform festgelegt werden. Diese Einstellung muss manuell in der Datenbank angelegt werden und kann danach in Onkostar verändert werden.

INSERT INTO einstellung (name, wert, kategorie, beschreibung)
VALUES (
 'consentform',
 'MR.Consent',
 'DNPM',
 'Zu verwendendes Consent-Formular'
);

Hier kann für Onkostar ab Version 2.13.x (oder neuer) anstelle System wieder DNPM verwendet werden.

Aktuell werden folgende Consent-Formulare unterstützt:

• MR.Consent
• Excel-Formular (UKW - beinhaltet Consent-Angaben)

classDiagram
class ConsentManagerService {
<<Interface>>
  + applyConsent(Procedure) void
  + canApply(Procedure) boolean
}
class ConsentManagerServiceFactory {
  + ConsentManagerServiceFactory(IOnkostarApi)
  + currentUsableInstance() ConsentManagerService
}
class MrConsentManagerService {
  + MrConsentManagerService(IOnkostarApi)
  + canApply(Procedure) boolean
  + applyConsent(Procedure) void
}
class UkwConsentManagerService {
  + UkwConsentManagerService(IOnkostarApi)
  + canApply(Procedure) boolean
  + applyConsent(Procedure) void
}

ConsentManagerServiceFactory  ..>  MrConsentManagerService : «create»
ConsentManagerServiceFactory  ..>  UkwConsentManagerService : «create»
MrConsentManagerService  ..|>  ConsentManagerService
UkwConsentManagerService  ..|>  ConsentManagerService

Eine Übernahme von Consent-Daten aus unbekannten Formularen ist nur manuell möglich.

Therapieplan

Soll das automatische Befüllen der Unterformulare Einzelempfehlung und Rebiopsie nicht durchgeführt werden, weil es mehrere MTBs je MTB-Episode gibt, so muss die Einstellung mehrere_mtb_in_mtbepisode vorhanden sein und auf den Wert true gesetzt sein.

INSERT INTO einstellung (name, wert, kategorie, optionen, beschreibung)
VALUES (
 'mehrere_mtb_in_mtbepisode',
 'true',
 'DNPM',
 '[{"key": "true", "value": "Ja"},{"key": "false", "value": "Nein"}]',
 'Angabe, ob mehrere MTBs je MTB-Episode verwendet werden.'
);

Auch hier kann für Onkostar ab Version 2.13.x (oder neuer) anstelle System wieder DNPM verwendet werden.

Mapping MTB zu Therapieplan-Protokollauszug

Das Plugin ermöglicht die Übernahme von Inhalten aus einem MTB in den Protokollauszug des DNPM Therapieplans. Für die Formulare

• OS.Tumorkonferenz
• OS.Tumorkonferenz.VarianteUKW
• MR.MTB_Anmeldung

liegen bereits Implementierungen vor. Um eigene Implementierungen vorzunehmen, die sich an andere Formulare oder Formularvarianten richtet, muss hierzu das Interface ProcedureToProtocolMapper implementiert werden. Dazu muss die Methode apply(Procedure) derart implementiert werden, sodass aus einer Prozedur ein entsprechender Abschnitt als Text für den Protokollauszug gewandelt wird.

Als Rückgabewert wird hierbei ein Wert vom Typ Optional<String> erwartet, dabei z.B. Optional.of("Text"), wenn ein zu verwendender Text oder z.B. Optional.empty() wenn kein zu verwendender Text zurückgegeben wird.

Anschließend ist das Mapping in DefaultMtbService in der Methode procedureToProtocolMapper(Procedure) einzutragen, beispielsweise durch

...
    case "Custom.Neuekonferenz":
        return new CustomNeuekonferenzToProtocolMapper();
...

classDiagram

class MtbService {
<<Interface>>
  + getProtocol(List~Procedure~) String
  + procedureToProtocolMapper(Procedure) ProcedureToProtocolMapper
}
class DefaultMtbService {
  + DefaultMtbService(IOnkostarApi)
  + getProtocol(List~Procedure~) String
  + procedureToProtocolMapper(Procedure) ProcedureToProtocolMapper
}
class MrMtbAnmeldungToProtocolMapper {
  + MrMtbAnmeldungToProtocolMapper(IOnkostarApi)
  + apply(Procedure) Optional~String~
}
class OsTumorkonferenzToProtocolMapper {
  + OsTumorkonferenzToProtocolMapper()
  + apply(Procedure) Optional~String~
}
class OsTumorkonferenzVarianteUkwToProtocolMapper {
  + OsTumorkonferenzVarianteUkwToProtocolMapper()
  + apply(Procedure) Optional~String~
}
class ProcedureToProtocolMapper {
<<Interface>>

}

DefaultMtbService  ..|>  MtbService
DefaultMtbService  ..>  MrMtbAnmeldungToProtocolMapper : «create»
DefaultMtbService  ..>  OsTumorkonferenzToProtocolMapper : «create»
DefaultMtbService  ..>  OsTumorkonferenzVarianteUkwToProtocolMapper : «create»
MrMtbAnmeldungToProtocolMapper  ..|>  ProcedureToProtocolMapper
OsTumorkonferenzToProtocolMapper  ..|>  ProcedureToProtocolMapper
OsTumorkonferenzVarianteUkwToProtocolMapper  ..|>  ProcedureToProtocolMapper

Idealerweise werden entsprechende UnitTests hinzugefügt.

Mapping Systemtherapie-Formular zu Prozedurwerten

Das Formular DNPM KlinikAnamnese verwendet eine Backend-Service-Funktion zum Ermitteln vorliegender Therapielinien. Für die Formulare

• OS.Systemische Therapie
• OS.Systemische Therapie.VarianteUKW

wird analog zum Mapping MTB auf Therapieplan-Protokollauszug eine formularspezifische Entscheidung getroffen, welcher Mapper zur Laufzeit verwendet werden soll. Der Mapper muss hierbei das Interface ProzedurToProzedurwerteMapper implementieren.

In der Klasse DefaultSystemtherapieService wird zur Laufzeit der erforderliche Mapper für das verwendete Formular ausgewählt.

An dieser Stelle kann auch eine eigene Implementierung - eine neue Klasse, die das Interface ProzedurToProzedurwerteMapper implementiert - integriert werden, indem das zu verwendende Formular (Formularname) und die zu verwendende Mapping-Klasse für den Formularnamen angegeben wird.

Hierbei kann in der Einstellung systemtherapieform festgelegt werden, dass ein anderes Formular als "OS. Systemische Therapie" verwendet werden soll. Diese Einstellung muss manuell in der Datenbank angelegt werden und kann danach in Onkostar verändert werden.

INSERT INTO einstellung (name, wert, kategorie, beschreibung)
VALUES (
 'systemtherapieform',
 'OS.Systemische Therapie',
 'System',
 'Zu verwendendes Formular für die systemische Therapie'
);

Berechtigungsprüfung

Dieses Plugin unterstützt eine Berechtigungsprüfung anhand von personenstammbasierten als auch formularbasierten Berechtigungen.

Mögliche Berechtigungsanforderungen sind sowohl für die PermissionEvaluatoren, als auch die Annotationen:

• PermissionType.READ
• PermissionType.READ_WRITE

Prüfung der Berechtigung mithilfe eines Permission Evaluators

Zur Prüfung der Berechtigung können die implementierten PermissionEvaluatoren einzeln als auch gemeinsam genutzt werden:

• PersonPoolBasedPermissionEvaluator: Berechtigungsprüfung basierend auf dem zugehörigen Personenstamm
• FormBasedPermissionEvaluator: Berechtigungsprüfung basierend auf dem zugehörigen Formular
• DelegatingDataBasedPermissionEvaluator: Berechtigungsprüfung basierend auf allen implementierten Evaluatoren

Beispiel der Anwendung

Das folgende Beispiel zeigt die Nutzung des DelegatingDataBasedPermissionEvaluators zur Prüfung, ob der aufrufende Benutzer Zugriff auf die Prozedur hat und gibt nur bei vorhandener Berechtigung den Namen des Formulars zu dieser prozedur zurück.

import dev.dnpm.security.DelegatingDataBasedPermissionEvaluator;
import de.itc.onkostar.api.IOnkostarApi;

class DemoAnalyzer implements IProcedureAnalyzer {

    private final DelegatingDataBasedPermissionEvaluator permissionEvaluator;

    private final IOnkostarApi onkostarApi;

    public DemoAnalyzer(
            DelegatingDataBasedPermissionEvaluator permissionEvaluator,
            IOnkostarApi onkostarApi
    ) {
        this.permissionEvaluator = permissionEvaluator;
        this.onkostarApi = onkostarApi;
    }

    // ... übliche Methoden für einen Analyzer

    // Beispiel: Gib Formularname zurück, wenn Prozedur mit ID existiert
    // und der aufrufende Benutzer lesenden Zugriff auf diese Prozedur hat.
    // Dabei: Zugriff auf Prozedur anhand Personenstamm und Formulartyp
    public String getFormName(Map<String, Object> input) {
        var procedureId = AnalyzerUtils.getRequiredId(input, "id");

        if (procedureId.isEmpty()) {
            return "";
        }

        var procedure = onkostarApi.getProcedure(procedureId.get());

        if (
                null != procedure
                        && permissionEvaluator.hasPermission(
                        SecurityContextHolder.getContext().getAuthentication(),
                        procedure,
                        PermissionType.READ
                )
        ) {
            return procedure.getFormName();
        }

        return "";
    }

}

Prüfung der Berechtigung und Absicherung von Methodenaufrufen

Zusätzlich zur Prüfung mit einem Permisison Evaluator sind, basierend auf Spring AOP, folgende Annotationen verfügbar:

• FormSecured: Berechtigungsprüfung wird für alle Argumente vom Typ Procedure anhand der Berechtigung auf das zugehörige Formular durchgeführt und erlaubt immer Zugriff auf Argumente vom Typ Patient
• FormSecuredResult: Berechtigungsprüfung wird für Rückgabewerte vom Typ Procedure anhand der Berechtigung auf das zugehörige Formular durchgeführt und erlaubt immer Zugriff auf Rückgabewerte vom Typ Patient
• PersonPoolSecured: Berechtigungsprüfung wird für alle Argumente vom Typ Procedure und Procedure anhand des zugehörigen Personenstamms durchgeführt.
• PersonPoolSecuredResult: Berechtigungsprüfung wird für Rückgabewerte vom Typ Procedure und Procedure anhand des zugehörigen Personenstamms durchgeführt.

Beispiel für Anwendung

Analog dazu eine Implementierung einer Service-Klasse, hier mit Spring-Annotation @Service.

Wird die Methode getFormName(Procedure) aufgerufen und der Benutzer hat keinen lesenden Zugriff auf die übergebene Prozedur, wird eine Exception geworfen.

import dev.dnpm.security.FormSecured;
import dev.dnpm.security.PermissionType;
import dev.dnpm.security.PersonPoolSecured;

@Service
class DemoService {

    @FormSecured(PermissionType.READ)
    @PersonPoolSecured(PermissionType.READ)
    public String getFormName(Procedure procedure) {
        return procedure.getFormName();
    }

}

Der Aufruf im Analyzer kann nun wie folgt aussehen:

import dev.dnpm.security.IllegalSecuredObjectAccessException;

class DemoAnalyzer implements IProcedureAnalyzer {

    private final DemoService service;

    public DemoAnalyzer(
            DemoService demoService
    ) {
        this.demoService = demoService;
    }

    // ... übliche Methoden für einen Analyzer

    // Beispiel: Gib Formularname zurück, wenn Prozedur mit ID existiert
    // und der aufrufende Benutzer lesenden Zugriff auf diese Prozedur hat.
    // Dabei: Zugriff auf Prozedur anhand Personenstamm und Formulartyp
    public String getFormName(Map<String, Object> input) {
        var procedureId = AnalyzerUtils.getRequiredId(input, "id");

        if (procedureId.isEmpty()) {
            return "";
        }

        var procedure = onkostarApi.getProcedure(procedureId.get());

        if (null != procedure) {
            try {
                return demoService.getFormName(procedure);
            } catch (IllegalSecuredObjectAccessException e) {
                // Keine Berechtigung gegeben.
                // Durch die Annotationen wird eine berechtigungsprüfung vorgenommen,
                // schlägt diese fehl, wird eine IllegalSecuredObjectAccessException geworfen.
                // In diesem Fall wird hier eine leere Zeichenkette als Rückgabewert zurückgegeben.
                return "";
            }
        }

        return "";
    }

}

Bauen des Plugins

Für das Bauen des Plugins ist zwingend JDK in Version 11 erforderlich. Spätere Versionen des JDK beinhalten einige Methoden nicht mehr, die von Onkostar und dort benutzten Libraries verwendet werden.

Voraussetzung ist das Kopieren der Datei onkostar-api-2.12.4.1.jar (oder neuer) in das Projektverzeichnis libs.

Weiterhin verwendet dieses Plugin das ATC-Codes-Plugin. Die zugehörige JAR-Datei muss ebenfalls in das Projektverzeichnis libs kopiert werden. Aktuell wird Version 0.6.0 verwendet.

Hinweis: Bei Verwendung einer neueren Version der Onkostar-API oder des ATC-Codes-Plugins muss die Datei pom.xml entsprechend angepasst werden.

Danach Ausführen des Befehls:

./mvnw package

Testen des Plugins und Code-Voverage

Die Entwicklung des Plugins erfolgt mit automatisierten Tests. Diese können zusammen mit einem Bericht über die Testabdeckung durch Ausführung des Befehls

./mvnw clean verify

ausgeführt werden.

Treten Fehler auf, so wird dies angezeigt. Einen Bericht über die Testabdeckung finden Sie als HTML-Seite unter target/site/jacoco/index.html.