1. Introduktion
Denne guide er primært målrettet til anvendere, som skal implementere en ny afprøvningsløsning og har til formål, at give eksempler på kode og opsætning af web applikation og facade til NAP.
Guiden beskriver en web applikation som bruger en backend, som interagerer med Dokumentdelingsservice (DDS), og som anvender oiosaml.java 2.21 (https://www.digitaliser.dk/resource/5359238) som sikkerhed- og autentikationslaget jf. Sikkerhedsarkitektur for iNSP løsninger.
Der er beskrevet instruktioner til opsætning af et web projekt og en backend, som overholder givne NSP standarder (Husregler for webløsninger og https://www.nspop.dk/display/public/web/Husregler+for+udvikling+til+NSP)
Guiden indeholder eksempler på kodeimplementationer, men ellers er projekterne tilgængelig på svn.nspop.dk og kan bruges som inspiration til et afprøvningsprojekt.
1.1. Sammenhæng med øvrige dokumenter
Dette dokument er en del af den samlede dokumentation for NAP Reference implementation.
Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.
Ønskes mere information omkring arkitektur og design findes dette på NAP Ref.Impl. - Design og Arkitektur beskrivelse.
Ønskes mere information omkring installationsvejledning til anvender kan findes på NAP Ref.Impl. - Installationsvejledning.
Hvis der er behov for yderligere dokumentation omkring hele NAP platformen, henvises til NAP Platform - Guide til anvendere.
1.2. NAP Ref.Impl. Opbygning
Nap-references består af en java backend (nap-reference-facade) samt en front for backend (nap-reference-web), bygget med angular frameworket og som anvender version 1.0.0 af nap-typescript-sdk og nap-angular-sdk.
Applikationens hovedfunktionalitet er at vise aftaledokumenter for den patient, der er i kontekst i det værtssystem, den er indlejret i (f.eks. nap-java-host). Derfor er funktionalitet i applikationen begrænset, hvis den åbnes uden at være framet.
Hvis applikationen køres indlejret i et værtssystem som understøtter sikker browser opstart og tilføjer NAP Bridge på global scope af indlejrede systeme kan kommunikation mellem host og nap-reference ske i gennem NAP SDK - Guide til anvendere.
Denne kommunikation giver muligheden for overførelse af informationer som patientkontekst og sessionsfejl mellem det indlejrede system og værtssystemet.
Når nap-reference får overført en patientkontekst kaldes facaden med det cpr nummer samt en SOR værdi tilføjet i en "X-OrganizationSor" header (denne værdi er hardcoded i dette tilfælde, da den ikke kan læses ud af SOSI IDkortet)". Facaden validere kaldet og viderestiller til Dokumentdelingsservice (DDS).
Nap-reference-facade sørger for at validere kaldet og hente relevante aftaledokumenter (via anvendelse af org.openehealth.ipf.commons) for den valgte patient. For at formatere aftaledokumenterne fra XML til objekter, bruges biblioteket "dk.s4.hl7.builders".
Før aftaledokumenterne returneres, bliver information, der anvendes nap-reference-web udtrukket.
2. Nap-reference-web
Nap-reference-web er bygget med Angular version 9 og fungerer som illustration på:
- Projekt opsætning overholdende https://www.nspop.dk/display/public/web/Husregler+for+udvikling+til+NSP.
Brug af NAP SDK NAP SDK - Guide til anvendere
- GUI for NAP Projekter.
Nap-reference-web er en front end til nap-reference-facade og deployes i dennes kontekst-rod i byggepipelinen.
Se NAP Ref.Impl. - Installationsvejledning for mere information omkring Jenkins pibeline.
2.1. Opsætning og struktur af et angular projekt
2.1.1. Komponenter
Angular frameworket lægger sig op af MVC (model-view-controller) design mønsteret, og dette er implementeret i nap-reference-web.
Der er simple komponenter til at visning af aftaler, hjælpeinformationer, fejl osv.
2.1.2. Services
Services håndterer forretningslogikken.
Der er simple services til håndtering af authentication, applikationsfejl og konfigurering osv.
2.1.3. Dependencies
Der er brugt dependencies, som er hentet igennem NSP nexus. Der ligger en .npmrc i projektet, som sætter npm registry til https://nexus.nspop.dk/nexus/repository/nsp-npm/ således dependencies fra package.json hentes herfra.
2.1.4. Konfiguration
Nap-reference-web benytter sig af en json konfigurationsfil, som loades via configurations servicen.
Der findes 2 konfigurationer en til dev (configurations-dev.json) samt en til releases (configurations.json) som adskiller sig i serverens url.
Configurations-dev.json anvendes til når nap-refence-web er under udvikling og køres via ng serve (så der kommer live reloading af kodeændringer), hvor configurations.json anvendes når nap-reference-web er pakket og deployet sammen med nap-reference-facade i kontekstroden.
For yderligere information omkring konfiguration henvises til NAP Ref.Impl. - Driftsvejledning.
Da INSP web applikationer og services kan blive deployet på vilkårlige url'er, og skal kunne loade ressourcer relativt til, hvor de er deployet, er det vigtigt at applikationen fungerer med relative paths.
Dette er opnået ved hashrouting.
@NgModule({
imports: [RouterModule.forRoot(routes, { useHash: true })],
exports: [RouterModule]
})
export class AppRoutingModule { }
Du kan læse mere på https://angular.io/guide/router
2.1.5. Debugging
Hvis Nap-reference-web åbnes i browser kan den debugges med almindelige developer tools.
Hvis den åbnes i nap-java-host, er den eneste debugging mulighed konsol logs.
2.1.6. Testing
Nap-reference-web benytter sig af testframeworket Karma, da det kommer default med angular. Karma bruger Istanbul til at generere test-coverage rapporter. Testene køres i en headless chromium browser.
For opbygning af tests, henvises til at kigge i projektets .spec filer.
2.1.7. Dokumentation
Koden er dokumenteret efter TSDoc standard og kan derfor genereres med TSDoc.
2.1.8. Logging
Der bliver logget til konsollen i tilfælde af fejl - endvidere sendes logiske fejl med NAP SDK'et, som beskrevet nedenfor.
2.2. Brug af NAP SDK
Nap-reference-web implementerer version 1 af eventkataloget, og da det er et angular projekt, er der gjort brug af nap-angular-sdk'et.
nap-reference-web gør brug af det udstillede interface i nap-angular-sdk, og nedenfor er der eksempler på hvordan det er blevet brugt.
2.2.1. Security (SAML logout samt Session-close NapEvent)
Der er lavet en AuthService, som sørger for at håndtere sessioner.
Nedenstående funktionalitet findes i src/app/services/auth.service.ts.
Auth service lytter på indkommende beskeder fra NAP SDK'et, og filtrerer beskeder, således der kun reageres på beskeder af typen SessionClose.
Hvis en bruger ønsker at blive logget ud sendes en besked med SessionClose fra den kontekst brugeren har igangsat eventet.
Det betyder at eventet både kan sendes fra indlejret system til værtsystem og omvendt.
Når brugeren skal logges ud skal browseren flyttes til saml/Logout på den server, der holder sessionen.
Se auth.service.ts i https://svn.nspop.dk/src/components/nap/nap-reference-web/trunk/src/app/services/
2.2.2. Patient-Open og Patient-close
I komponenten appointment (src/app/appointment/), vises de forskellige aftaler for den givne patient.
For at få den nuværende patient, sendes en besked med typen PatientOpen igennem SDK'et. Dette gøres i constructoren.
Herefter lyttes der på indkommende beskeder med typen PatientOpen. Der gøres brug af en hjælpe metode i nap-typescript-sdk, FHIRValueGetter.getPatientInfo(), som konvertere den indkommende besked til et objekt som indeholder patient oplysningerne.
Hvis den nuværende patient skal lukkes, set fra det indlejrede systems perspektiv, sendes der en besked med typen PatientClose.
se appointment.component.ts i https://svn.nspop.dk/src/components/nap/nap-reference-web/trunk/src/app/appointment/
2.2.3. Session-Error
I appointment service (src/app/service/appointment.service.ts) vises et eksempel på fejlhåndtering som skal gå igennem NAP SDK'et.
createNapErrorMessage() opbygger en besked med typen SessionError, som indikerer der er sket en uventet fejl i projektet som skal sendes til værtssystemet og vice versa.
Fejlen bliver sendt hvis kaldet til getAppointments() fejler.
se appointment.service.ts i https://svn.nspop.dk/src/components/nap/nap-reference-web/trunk/src/app/services/
3. Nap-reference-facade
Nap-reference-facade er backend til nap-reference-web.
Nap-reference-facade er bygget med java 8 og fungerer som illustration på:
- Projekt opsætning overholdende https://www.nspop.dk/display/public/web/Husregler+for+udvikling+til+NSP.
- Sikkerhed i NAP kontekst Sikkerhedsarkitektur for iNSP løsninger
Brug af Dokumentdelingsservice (DDS)
I bygge processen lægges nap-reference-web ind i src/main/webapp, hvorfra disse er tilgængelig i kontekstroden. Se NAP Ref.Impl. - Installationsvejledning for mere information omkring Jenkins pibeline.
3.1. Opsætning og struktur
3.1.1. Dependencies
Dependencies er hentet fra https://nexus.nspop.dk/nexus/content/groups/public og de dependencies, som stilles til rådighed af wildfly8 platformen er angivet med scope provided.
For at kunne kalde Dokumentdelingsservice (DDS) er følgende dependencies anvendt:
dk.sosi.seal | Java-bibliotek til understøttelse af "Den Gode Webservice" og validering af SAMLassertion, se http://digitaliser.dk/group/374971. |
dk.s4.hl7.builders | Dansk profileret XML converter af hl7 clinical documents |
org.openehealth.ipf.commons | Dansk profileret bibliotek til Cross Enterprise Document sharing. Bruges til at integrere Dokumentdelingsservice (DDS). Du kan læse mere på https://github.com/KvalitetsIT/aftaledeling/tree/master/dgws-eksempel/src/main/java/dk/sds/appointment. |
dk.digst.oiosaml2.java | Danske profilering af OASIS SAML 2.0 standarden. |
3.1.2. Konfiguration
Alt konfiguration foregår ved at loade filer fra et selv-defineret wildfly modul og ind i classpath under deployment.
Dette gør wildfly ved at modulet defineres i jboss-deployment-structure.xml.
Der findes flere information om hvordan nap-refernece-facade konfigureres på NAP Ref.Impl. - Driftsvejledning.
3.1.3. Testing
Testene bliver eksekveret af maven-surefire-plugin med test frameworket junit. Test coverage bliver målt af Jacoco.
3.1.4. Dokumentation
Kodedokumentationen overholder javadoc standarden således dette kan generes med et værktøj fra fx den IDE man bruger.
3.2. Sikkerhed
Sikkerhedsarkitekturen følger det skitserede i Sikkerhedsarkitektur for iNSP løsninger. Dermed er der åben for mulighederne for integration til udbredte procedure Sikker browser opstart, samt understøtter tilslutning til Nemlogin.
3.2.1. dk.digst.oiosaml2.java
Anvendes som autentifikationsfilter. For at et OIOSAML kan loades skal oiosaml-kofigurationer være placeret i oiosaml.home under deployment.
Indstilling af oisaml.home og konifiguration af OIOSAML sker som vist i compose/development/docker-compose.yml med environmental variable og ved mounte konfigurationsfiler ind.
For registreing af SPFIlter se SpringLoader.Java i https://svn.nspop.dk/src/components/nap/nap-reference-facade/trunk/src/main/java/dk/sds/nsp/nap/reference/facade/
OIOSAML sørger for at validere den assertion der kommer fra en given iDP (https://www.nspop.dk/display/public/web/Sikkerhedsservices+%28STS%29+-+Leverancebeskrivelse i dette tilfælde) og tilføjer denne til brugerens session.
Der findes eksempel på hvordan OIOSAML konfigureres på NAP Ref.Impl. - Guide til udviklere.
3.2.2. SOSI idkort fra Samlassertion
Desuden er der implementeret et service specifikt autentifikationsfilter, der udtrækker det IDkort, som er indlejret i en SAMLassertion så det kan bruges i DGWS kald.
Se AuthFilter.java i https://svn.nspop.dk/src/components/nap/nap-reference-facade/trunk/src/main/java/dk/sds/nsp/nap/reference/facade/filters/AuthFilter.java
3.2.3. dk.sosi.seal
Seal anvendes til at indlejre et SOSI IDkort i et XML dokument som er parseable for DGWS.
for et eksemple på en SOAP interceptors, som sætter en DGWS header for client requests til DGWS se https://svn.nspop.dk/src/components/nap/nap-reference-facade/trunk/src/main/java/dk/sds/nsp/nap/reference/facade/soapinterceptor/.
3.3. Snitfladebeskrivelse og brug
Nap-reference-facades snitflader bliver beskrevet i følgende.
3.3.1. oiosaml
Dokumentationen OIOSAML kan læses her https://github.com/digst/OIOSAML.Java/tree/master/docs
Men konkret anvendes følgende 2 endpoints til autentifikation og logout.
3.3.1.1. /saml/SAMLAssertionConsumer
Brugeres til at validere autentifikations requests og registrere en brugers assertion i en threadlocal session.
3.3.1.2. /saml/Logout
Bruger til single logout. Den sletter brugerens session.
3.3.2. /youAreLoggedOut
Anvendes af oiosaml.java som for singleLogoutService i forbindelse med Sikker browser opstart.
Hvis en bruger, som har startet applikationen med sikker browser opstart ønskes logget ud, vil oiosaml.java navigerer brugeren til dette endpoint, når brugeren er blevet logget ud.
Dette endpoint er derfor ikke beskyttet af autentikationsfilter og vil altid returnere 200 samt en html, der fortæller brugeren er logget ud.
3.3.3. /aftaler/{cpr}
Den eneste aftager af denne service er nap-reference-web.
| Headers | |
|---|---|
| Key | Value |
| X-OrganizationSor | Sor nummer (bruges af dokumentdelingsservicen) |
3.3.4. /isAlive
Bruges af NSP loadbalanceren for at tjekke at servicen er deployet. Returnerer en html side med deployment info.
Da denne service ikke er afhængig af database eller andre interne services, returnere den altid statuskode 200, hvis applikationen kører.
3.4. Eksempel på request/response
http://nap/web/reference/services/main/aftaler/124567890
{
"title": "Ekkokardiografi",
"orgName": "Skejby Sygehus",
"indication": "Har ondt i hjertet somme tider",
"date": 1591142400
}