Anchor_Toc40578283_Toc40578283Version 0.713, 20172019-0307-14 12 Indhold

Formål

...

Dette dokument beskriver arkitekturen for Behandlignsrelationsservicen (BRS).
Der beskrives

• Moduler i BRS
• Services og jobs, der rummes af BRS
• NSP miljøer, hvorpå i BRS modulerne er installeret
• Dataflow
• Datamodul, herunder databaser og tabelstruktur.

...

Behandlingsrelationsservicen (BRS) udstillet på NSP er en service til kontrol af behandlingsrelationer. BRS tilbyder at løfte opgaven med at klassificere behandlingsrelationer imellem sundhedsfaglige personer og patienter, således at nationale serviceudbydere i sundhedsvæsenet lettere kan overholde lovkrav til kontrol af sundhedsfaglige personers adkomst til data og funktionalitet.
Da der ikke findes et decideret "behandlingsrelationsregister", er det nødvendigt at udlede viden om faktiske behandlingsrelationer ved opslag i nationale registre over handlinger, registreringer og relationer indenfor sundhedsvæsenet. Endvidere er der ofte en tidsmæssig forsinkelse i opsamling af de nødvendige informationer, og det er derfor nødvendigt at give adgang til funktionalitet og data på basis af ukomplette informationer, og efterfølgende foretage en opfølgende kontrol af den faktiske relation på et senere tidspunkt.
Opslag og opfølgninger varetages af BRS.
Image Removed Hvis en serviceudbyder giver adgang til en bruger under forudsætning af at brugerens adkomst senere kan bekræftes, men det ikke sker, udsteder BRS en alarm, som serviceudbyderen kan agere på (en manuel opfølgning).
Systemet er opdelt i to dele "frontend" og "backend".

...

Frontend'en indeholder behandlingsrelationsservicen og notifikationsservicen, som er de webservices, der kaldes udefra, fra eksempelvis FMK. Herudover afvikles et job som løbende replikerer behandlingsrelationer, der er sat til opfølgning, til backend'en.
Frontend'en er installeret i dNSP-miljøerne (decentral National Service Platform), samt til i cNSP-miljøet (central National Service Platform).

...

Backend'en indeholder en webservice, som modtager de data, der replikeres fra frontend'en. Herudover afvikles der et batchjob, der foretager løbende opfølgning på, om der er opnået evidens for de behandlingsrelationer, der er sat til opfølgning, og opretter alarm-notifikationer i de tilfælde, hvor evidens ikke blev opnået indenfor tidsfristen. Endelig afvikles et andet bachjob, der løbende sletter gamle notifikationer.
Backend'en er installeret i NSP's Backoffice-miljø (tidligere benævnt DoDi).
I Backoffice opsamles data fra følgende kilderegistre:

• Landspatientregistret (LPR)
• Sygesikringsregistret (SSR)
• Henvisningshotellet (Refhost)
• Sikrede (AssignedDoctor)

Data indsættes i de samme MySQL databaser, som BRS anvender, men det foretages i praksis af separate stamdata-importere.
Disse data, samt de notifikationer, der er oprettet af opføgningsjobbet, replikeres løbende til NSP-miljøerne, så data er tilgængelige for frontend'en. Denne replikering foretages i praksis som MySQL-databasereplikering.

...

På NSP-miljøerne udstilles følgende webservices:
Behandlingsrelationservice (BRS):
Servicen modtager en forespørgsel på en behandler (identificeret som person+sted), samt en patient (identificeret ved CPR), og skal afgøre hvilke kategorier af relationer der er mellem behandleren og patienten.
Der angives ligeledes et succeskriterie i form af et sæt af kategorier, der antages at være acceptable behandlingsrelationer. Skulle der ikke være en acceptabel behandlingsrelation, kan det afføde en opfølgning. For at understøtte dette, kan kalderen angive et sæt af kategorier der skal afføde en opfølgning. Dette kan også være sat til alle relationer.
Notifikationsservice:
Servicen vil returnere alle notifikationer, som er adresseret til kalderen. Notifikationer er fortløbende nummererede, og kalderen kan angive et offset, der sikrer at kun de nyeste notifikationer returneres. Servicen sletter alarmer efter et centralt konfigurerbart tidsinterval. Hvis man ikke angiver offset kan man risikere at modtage de samme alarmer flere gange.
De ovennævnte services udstilles via Den Gode Webservice (DGWS 1.0.1), og kan kun kaldes af systemer der bruger et System-IDKort udstedt til forhåndsgodkendte CVR numre. IDKort skal være udstedt af SOSI-STS.

...

Backoffice indeholder to batchjobs der begge afvikles periodisk. Schedule for jobs kan konfigureres vha. en cron expression.
Relationsopfølgning:
De gemte opfølgninger kontrolleres op imod valideringsbiblioteket for at undersøge om der er opstået relationer der giver anledning til at slette en opfølgning. Hvis en opfølgning ikke har opnået den krævede relationskategori inden dens udløb oprettes en alarm i notifikationsdatabasen via GOS.
Oprydning:
Alarm-notifikationer replikeres til frontend i NSP-miljøerne, hvor de kan hentes med notifikationsservicen. Dette sletter dog ikke notifikationerne, så for at undgå at der blot bliver flere og flere, er der på et oprydningsjob, som løbende sletter notifikationer, som er blevet tilpas gamle.
Sletningen replikeres, så data også slettes fra de øvrige miljøer.

...

Valideringsbiblioteker har adgang til data fra en række databaser, deriblandt landspatientregisteret og sygesikringsregisteret, for at kunne udlede om en behandlingsrelation er til stede. Valideringsbiblioteket tilgås af behandlingsrelationservicen i dNSP/cNSP-miljøerne samt relationsopfølgningsjobbet i Backoffice miljøet.
Valideringsbiblioteket er implementeret som en fælles kodebase, der deles af front- og backend modulerne.

...

Dette dokument beskriver installation og konfiguration af Behandlingsrelations-servicen (BRS).

Servicen omfatter to komponenter:

• brs-frontend.war til installation i NSP-miljøer (de decentrale dNSP miljøer og det centrale cNSP miljø). Denne indeholder webservices til opslag af evidens for behandlingsrelationer og hent af alarm-notifikationer.
• brs-backend.war til installation i det centrale Backoffice miljø. Denne service indeholder batchjobs til løbende opfølgning på evidens for behandlingsrelationer og generering af alarm-notifikationer.

I denne vejledning beskrives krav til operativsystem og serversoftware, samt installation og konfiguration af de ovennævnte komponenter.

Krav til miljø

Krav til applikationsservere

Komponenterne er udviklet og testet under Jetty og Wildfly 8, og kan deployes i produktion på alle nævnte applikationsservere. Dog er der kun skrevet installationsvejledning for deployment på Wildfly 8, da det er denne platform som bruges på den nationale service platform (NSP).

Applikationsserveren kræver Java 8 eller højere.

Krav til operativsystem

Der stilles ingen krav til operativsystemet, ud over det åbenlyse krav om at Java er understøttet på operativsystemet. Ubuntu Linux bruges som operativsystem på NSP’en, men udviklingen af komponenten er foretaget på hhv. OS X og Windows 10, og disse platforme kan ligeledes afvikle komponenterne.

Krav til database

Komponenten er testet mod MariaDB version 10.0. Det er den samme MySQL version som bliver brugt på NSP platformen (NIAB version 1.1.3).

Krav til hardware

Der er nogle minimumskrav for at kunne afvikle komponenten fornuftigt til testformål. Dog skal man forvente at bruge high-end hardware (både cpu, ram, netkort & diske) for at kunne opfylde svartidskravene på NSP platformen.

Minimumskravene, for fornuftig performance på et test-setup, er

• Intel Core 2 eller lignende CPU
• 2 GB ram
• Nødvendig harddisk plads for at kunne håndtere alle registre (10+ GB)

Oprettelse af databaser og tabeller

Herunder beskrives opsætningen af databaserne, samt oprettelsen af tabellerne. Alle filer der refereres til kommer fra et SVN checkout. Den seneste version kan findes på https://svn.nspop.dk/svn/trifork/brs/trunk/

Tilgang til Stamdataudstillet database

Behandlingsrelationsservicen benytter data fra Stamdatamodulet. Servicen benytter tabellen ”AssignedDoctorⁱ”. Databasen fra Stamdata indeholdende pågældende tabel skal derfor være til rådighed for både frontend-modulet i NSP-miljøerne og backend-modulet i Backoffice-miljøet.

Oprettelse af database og tabeller i Backoffice-miljøet

Databasen ”register_notifications” oprettes.

Følgende sql scripts skal køres på ”register_notifications” databasen (i nævnte rækkefølge):

1. Behandlingsrelation/common/src/main/resources/sql/create-register_notifications-tables.sql
2. Behandlingsrelation/common/src/main/resources/sql/mysql-register_notifications-alter-tables.sql
3. Behandlingsrelation/common/src/main/resources/sql/create-whitelist_config-table.sql

Databasen ”followup” oprettes.

Følgende sql scripts skal køres på ”followup” databasen (i nævnte rækkefølge):

1. Behandlingsrelation/common/src/main/resources/sql/create-treatmentrelationfollowup-tables.sql
2. Behandlingsrelation/common/src/main/resources/sql/mysql- treatmentrelationfollowup-alter-tables.sql

Oprettelse af database og tabeller i dNSP/cNSP-miljøer

Databasen ”register_notifications” oprettes som en replikeret kopi af samme database i Backoffice miljøet.

Databasen ”followup” installeres.

Følgende sql scripts skal køres på ”followup” databasen (i nævnte rækkefølge):

1. Behandlingsrelation/common/src/main/resources /sql/create-followup-tables.sql
2. Behandlingsrelation/common/src/main/resources /sql/mysql-followup-alter-tables.sql

Deployment på Wildfly 8

Denne sektion beskriver deployment processen på Wildfly 8

Konfiguration af properties

Der kræves forskellige property-filer afhængigt af om der er tale om deployment på dNSP/cNSP eller Backoffice. Hvis der deployes på NSP, skal der være en brs-frontend.properties til rådighed, og hvis der deployes til Backoffice, skal der være en brs-backend.properties til rådighed.

I Backoffice-miljøet placeres brs-backend.properties i Wildfly 8’s standalone/configuration folderen til Wildfly. Tilsvarende placeres brs-frontend.properties i samme folder i NSP-miljøerne.

Konfiguration af logging

I filen standalone/configuration/standalone.xml indsættes en logging-profil.

På NSP/frontend indsættes følgende under ”logging-profiles”

<logging-profile name="brs-frontend">
    <size-rotating-file-handler name="METRICS-FILE">
        <formatter>
            <pattern-formatter pattern="%d{dd MMM yyyy HH:mm:ss:SSS} app=%c, logLevel=%p, thread=%t, %m%n"/>
        </formatter>
        <file relative-to="jboss.server.log.dir" path="metrics.log"/>
        <rotate-size value="10M"/>
        <max-backup-index value="5"/>
        <append value="true"/>
    </size-rotating-file-handler>
    <size-rotating-file-handler name="FRONTEND-FILE">
        <level name="DEBUG"/>
        <formatter>
            <pattern-formatter pattern="%d{dd MMM yyyy HH:mm:ss:SSS} app=%c, logLevel=%p, thread=%t, %m%n"/>
        </formatter>
        <file relative-to="jboss.server.log.dir" path="brs-frontend.log"/>
        <rotate-size value="10M"/>
        <max-backup-index value="5"/>
        <append value="true"/>
    </size-rotating-file-handler>
    <size-rotating-file-handler name="FRONTEND-AUDIT-FILE">
        <formatter>
            <pattern-formatter pattern="%d{dd MMM yyyy HH:mm:ss:SSS} app=%c, logLevel=%p, thread=%t, %m%n"/>
        </formatter>
        <file relative-to="jboss.server.log.dir" path="brs-frontend-audit.log"/>
        <rotate-size value="10M"/>
        <max-backup-index value="5"/>
        <append value="true"/>
    </size-rotating-file-handler>
    <root-logger>
        <level name="INFO"/>
        <handlers>
            <handler name="FRONTEND-FILE"/>
        </handlers>
    </root-logger>
    <logger category="audit.dk.nsi.brs" use-parent-handlers="false">
        <level name="INFO"/>
        <handlers>
            <handler name="FRONTEND-AUDIT-FILE"/>
        </handlers>
    </logger>
    <logger category="dk.nsi.brs.common.metrics" use-parent-handlers="false">
        <level name="DEBUG"/>
        <handlers>
            <handler name="METRICS-FILE"/>
        </handlers>
    </logger>
    <logger category="org.hibernate">
        <level name="WARN"/>
    </logger>
    <logger category="org.springframework">
        <level name="WARN"/>
    </logger>
    <logger category="httpclient.wire">
        <level name="WARN"/>
    </logger>
    <logger category="org.apache">
        <level name="WARN"/>
    </logger>
    <logger category="com.sun">
        <level name="WARN"/>
    </logger>
</logging-profile>

På Backoffice/backend laves samme konfiguration, blot angives “backend” i stedet for “frontend”.

Eksempel på opsætning af logning findes i integration/src/test/resources/standalone.xml

Deployment af komponenter

Alle komponenter der skal deployes til Wildfly, skal kopieres til mappen ”standalone/deployments”.

• På dNSP/cNSP deployes brs-frontend.war
• På Backoffice deployes brs-backend.war

Herunder følger en tabel over komponenter, samt en kort beskrivelse af deres formål.

Der henvises til driftsvejledningen for yderligere information

Opgradering af komponenter

Når der kommer opgraderinger til en komponent, vil der medfølge releasenotes, der beskriver opgradering, fallback, osv. for den enkelte komponent.

Konfiguration af komponenterne

Al konfiguration på NSP og Backoffice foregår ved redigering af hhv. brs-frontend.properties og brs-backend.properties, der placeres i standalone/configuration folderen under Wildfly. En skabelon til disse filer findes i integration/src/test/resources. Filerne konfigureres og placeres i standalone/configuration biblioteket på Wildfly.

Bemærk at brs-frontend.properties og brs-backend.properties i visse situationer ”overlapper”, dvs. indeholder ens properties. Dette skyldes bl.a. at funktionalitet til opslag af evidens for en behandlingsrelation findes i både frontend og backend.

For en oversigt over de enkelte properties og deres default-værdier henvises til driftsvejledningen, som også findes under ”docs”.

Whitelisting af services

Adgang til BRS services styres på CVR niveau. Adgang til services kan styres enten via property filen, eller via en lignende konfiguration i whitelist_config tabellen.

Vælges DATABASE som styringsmodel for whitelisting i propertyen "dk.nsi.auth.whitelistservice.type” anvendes de komma-separerede lister i propertyfilen ikke. I stedet indsættes en record i tabellen for hver adgang der skal gives. Nedenstående eksempler angiver formatet.

Eksempler på at oprette adgang til BRS

INSERT INTO whitelist_config (service_key, service_type, cvr) VALUES ('dk.nsi.auth.brs.cvr.list', 'NO_TYPE', '55832218');

Eksempler på at oprette query-adgang til notifications-servicen

INSERT INTO whitelist_config (service_key, service_type, cvr) VALUES ('dk.nsi.auth.query.type.cvr.list', 'BRS', '55832218');

Start/genstart af komponenterne

Alle komponenter kan genstartes ved ”touch” af de enkelte war filer på Wildfly. Alternativt kan Wildfly genstartes ved at køre kommandoen

service wildfly8 restart

Ændringslog

...

Der er to typer databaser i datamodellen:

• En opfølgningsdatabase
• En database med registre og notifikationer

Tabellerne på de to typer databaser er beskrevet i det følgende.

...

Opfølgningstabellen indeholder behandlingsrelationer, som er modtaget af behandlingsrelationsservicen, og som er sat til opfølgning, idet der ikke umiddelbart kunne opnås tilstrækkelig evidens for relationen i forhold til evidenskilderne.
Tabellen udgør en form for kø. Replikeringsjobbet læser fra denne og sender data til backend'en, hvorefter data slettes fra tabellen.

...

Opfølgningstabellen indeholder behandlingsrelationer, som er sat til opfølgning, og er blevet overført til backend'en. Data ligger i denne tabel så længe der ikke er opnået evidens for relationen, og tidsfristen ikke er overskredet.

...

Navn

...

Type

...

Beskrivelse

...

pk

...

bigint, auto_increment

...

Primære nøgle

...

patientCpr

...

varchar(80)

...

SHA-1 hash

...

admittedStart

...

datetime

...

admittedEnd

...

datetime

...

lprReference

...

varchar(40)

...

Fra inputdata – audit

...

relationType

...

varchar(40)

...

Se kommentarer

...

organisationIdentifier

...

varchar(7)

...

ydernummer eller SKS-kode

...

Følgende tabel benyttes til mapning fra input SKS-koder til SOR-koder:

...

Navn

...

Type

...

Beskrivelse

...

Data fra LPR3 findes i en tabel med dette skema:

...

Navn

...

Type

...

Beskrivelse

...

pk

...

bigint, auto_increment

...

Primære nøgle

...

patientCpr

...

varchar(80)

...

SHA-1 hash

...

admittedStart

...

datetime

...

admittedEnd

...

datetime

...

lprReference

...

varchar(256)

...

Fra inputdata – audit

...

relationType

...

varchar(40)

...

Se kommentarer

...

sorKode

...

bigint(20)

...

SOR-kode

Relationstypen kan antage følgende værdier:

• FORLOEBSELEMENT
• KONTAKT
• PROCEDURE
• INITIEL_HENVISNING
• HENVISNING
• RESULTATINDBERETNING
• OPHOLDSADRESSE

...

Navn

...

Type

...

Beskrivelse

...

pk

...

bigint, auto_increment

...

Primære nøgle

...

patientCpr

...

varchar(80)

...

SHA-1 hash

...

doctorOrganisationIdentifier

...

varchar(6)

...

ydernummer

...

admittedStart

...

datetime

...

admittedEnd

...

datetime

...

externalReference

...

varchar(40)

...

Fra inputdata - audit

...

Navn

...

Type

...

Beskrivelse

...

pk

...

bigint, auto_increment

...

Primære nøgle

...

healthProfessionCpr

...

varchar(80)

...

SHA-1 hash

...

doctorOrganisationIdentifier

...

varchar(6)

...

ydernummer

...

hospitalOrganisationIdentifier

...

varchar(7)

...

SKS-kode

...

EAN

...

char(13)

...

EAN-nummer

...

patientCpr

...

varchar(80)

...

SHA-1 hash

...

referralStart

...

datetime

...

Henvisningens start

...

referralEnd

...

datetime

...

refhostReference

...

varchar

...

Fra inputdata – audit

...

Notifikationstabellen i Backoffice-miljøet indeholder alarm-notifikationer for behandlingsrelationer, som der ikke kunne findes evidens for indenfor tidsfristen.

...

Behandlingsrelationsservicen benytter data udstillet af Stamdatamodulet. Det drejer sig om tabellen AssignedDoctor der dækker registret "Sikrede". Dokumentationen af denne tabel forefindes i dokumentationen for Stamdata.

...

Der henvises til NSP-dokumentationen for information vedrørende den overordnede arkitektur og omkringliggende komponenter.
Komponenter og services beskrevet her følger de overordnede retningslinier og krav udstukket af NSP-operatøren, herunder:

• Alle services skal bruge MySQL databaser til persistering af data.
• Alle services skal kunne eksekveres på JBoss. Aktuelt anvendes Wildfly 8.2.
• Al tilgang til services udefra skal foregå ved brug af den gode webservice (DGWS) (STS-signerede IDkort, niveau 3).
  • Internt anvendes usignerede DGWS niveau 1 ID-kort til kommunikation mellem frontend og backend.

...

Kilden til dette dokument kan findes på:
https://svn.nspop.dk/svn/trifork/brs/trunk/doc/

...