Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

nap-reference-web

nap-reference-facade 

...

1.2. Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP SDK.

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

Derudover findes der yderligere diagrammer og NAP SDK'erne på NAP SDK - Design og Arkitektur beskrivelse.

...


 NAP Ref.Impl. Opbygning

nap-reference-web er en web applikation, som anvender nap-typescript-sdk og nap-angular-sdk. Dette  Dette kan køres indlejret i et værtssytem (eks. nap-java-host), hvori der tilføjes en NAP Bridge på den givne applikations global scope, således der kan kommunikeres med SDK'erne. Igennem kommunikationen vil der blive håndteret sikkerhed igennem Denne kommunikation håndterer sikkerhed via anvendelse af en SAML assertion og patient konteksten vil kunne blive brugt igennem SAMLassertion, og giver muligheden for overførelse af patientkonteksten til det indlejret værtssystem.Derefter tilføjes SAML assertion som en header, samt en hardcoded SOR værdi som i en "X-Organization Sor headerOrganizationSor" header (denne værdi er hardcoded i dette tilfælde), til kaldet af dokumentationdelingsservicen, som går igennem til nap-reference facade.  reference facade, der efterfølgende kalder dokumentationdelingsservicen.

nap-reference-facade er en java applikation, som anvender SEAL.java til at validere den SAMLAssertion der bliver sendt ind i authentication headeren. Den står for at hente relevante aftale dokumenter aftaledokumenter (org.openehealth.ipf.commons) fra for den valgte patient. For at at formatere aftaledokumenterne fra XML til objekter, bruges biblioteket "dk.s4.hl7.builders". Før objekterne returneres, bliver kun relevant information sendt tilbage til nap-reference-web. 

...

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).

JGG: Lidt i tvivl om dette afsnit. Tænker selve opsætning af projektet til anvendelse skal bruge compose / test og ikke med et udviklings setup. Dette setup skal måske beskrives under "opsætning og struktur" Skal vi beskrive de forskellige setups?

Når applikationen er indlejret i et værtssystem er der to muligheder for at starte web klienten webklienten med docker-compose (INDSÆT LINK TIL OPSÆTNING AF DOCKER-COMPOSE)

...

For opbygning af tests, henvises til at kigge i projektets .spec filer. 

Dokumentation

Koden er dokumenteret efter TSDoc standard og kan derfor generes med TSDoc

...

Nap-reference-web implementerer version 1 af eventkataloget, og da det er et angular projekt, er der gjort brug af nap-angular-sdk'et. 

...

Testene bliver eksekveret af maven-surefire-plugin med test frameworket junit. Test coverage bliver målt af Jacoco.

Dokumentation

Kodedokumentationen overholder javadoc standarden således dette kan generes med et værktøj fra fx den IDE man bruger.

...