1. Introduktion

1.1. Formål

Formålet med dette dokument er at beskrive systemarkitekturen for NXRG.

1.2. Læsevejledning

Nærværende dokument er tiltænkt udviklere og IT-arkitekter med interesse i NXRG og dens opbygning.

1.3. Definitioner og referencer

2. Overblik over NXRG

I det følgende gives et overblik over NXRG. Først beskrives NXRG i forhold til dennes samarbejdende services og interne arkitektur (modulopdeling etc.)

Efterfølgende beskrives og begrundes den underliggende datamodel.

2.1. Løsningsoverblik

XDS er baseret på, at dokumentkilder i et index registrerer metadata om dokumenter, de kan stille til rådighed. En dokumentanvender kan herefter foretage opslag på indexet og ud fra returnerede metadata, foretage indhentning af dokumenter til efterfølgende visning og/eller udtræk af informationer.

Implementeringen af XDS i NXRG er illustreret i nedenstående model.

* Hver kasse i ovenstående diagram har en kort forklaring, som kommer frem i et nyt browservindue, når der klikkes på kassen.

2.1.1. Samarbejdende services

NXRG samarbejder med følgende komponenter i NSP infrastrukturen:

• Dokumentdelingsservice : DDS anvender den af NXRG udbudte ITI-18 snitflade til at udføre søgninger efter data registreret i NXRG.
• OpenXDS Repository: OpenXDS Repository opbevarer de konkrete dokumenter, der registreres på NSP XDS. OpenXDS anvender NXRGs udbudte ITI-42 snitflade for at få indexeret det metadata, som følger med de konkrete dokumentregistreringer.
• DROS: DROS udbyder registrerings- og opdaterings snitflader ud mod anvendersystemerne. DROS proxy'er kald af ITI-42, ITI-57 og ITI-61 videre til NXRG på de udbudte snitflader.
• Driftsskeduleret oprydning (XDSCleanup): Da dokumentregistreringer kun skal leve i NXRG i begrænset tid (de konkrete regler for opbevaring besluttes af de tilsluttede projekter), skal driften have mulighed for at rydde op (slette) gamle dokumentregistreringer, som ikke længere skal opbevares i NXRG. Der udbydes snitflader til oprydning af NXRG.

Diagrammet nedenfor viser både løsningens snitflader og eksterne services, som denne samarbejder med. Derudover vises den NXRGs intern lagdelte opbygning (herunder specificering af ansvarsfordelingen i de forskellige lag i applikation).

NXRG er opbygget i en lagdelt arkitektur. I ovenstående diagram er pakkenavne specificeret og giver en kobling til den konkrete sourcekode, der realiserer NXRG (se i øvrigt NXRG - Guide til Udviklere).

2.1.2. Snitflader

De udbudte snitflader er realiseret som SOAP webservices (dk.nsp.nxrg.ws). ITI-XX snitfladerne er specificeret i IHE XDS revision 17 fra juli 2020.

Se følgende:

• ITI TF-1: IHE IT Infrastructure Technical Framework Volume 1 (ITI TF-1) Integration Profiles (Revision 17.0 – Final Text)
• ITI TF-2a: IHE IT Infrastructure Technical Framework Volume 2a (ITI TF-2a) Transactions Part A (Revision 17.0 – Final Text)
• ITI TF-2b: IHE IT Infrastructure Technical Framework Volume 2b (ITI TF-2b) Transactions Part B (Revision 17.0 – Final Text)
• ITI TF-3: IHE IT Infrastructure Technical Framework Volume 3 (ITI TF-3) Cross-Transaction Specifications and Content Specifications (Revision 17.0 – Final Text)
• ITI TF-Metadata: IHE IT Infrastructure Technical Framework Supplement XDS Metadata Update Rev. 1.11 – Trial Implementation July 12, 2019

Til at realisere disse ITI-XX snitflader anvendes tredjeparts biblioteker fra IPF Open eHealth Integration Platform til implementations- og hjælpeklasser (herunder mapning af XML baseret model til domænemodel).

2.1.3. Forretningslag

Forretningsregler i relation til de udbudte ITI-XX services er implementeret udfra specifikationen af IHE XDS (dk.nsp.nxrg.service). For ITI-18 er det besluttet ikke at understøtte samtlige querytyper, der fremgår af specifikationen, men at nøjes med følende:

• FindDocuments
• FindDocumentsByReferenceId
• GetDocuments

Kald af ITI-18 med andre querytyper vil resultere i en fejlkode fra NXRG (se NXRG - Guide til Anvendere).

2.1.3.1. Validering af forespørgler og svar

Forespørgsler og svar valideres efter reglerne beskrevet i IHE XDS specifikationen. Mere præcist udføres validering som beskrevet i følgende afsnit:

• ITI-18: Afsnit 3.18.4 (Se ITI TF-2b).
• ITI-42: Afsnit 3.42.4 (Se ITI TF-2b).
• ITI-57: Afsnit 3.57.4 (Se ITI TF-Metadata).
• ITI-61: Afsnit 3.61.4 (Se ITI TF-2b).

2.1.3.1.1. Validerings opsætning

Open eHealth frameworket, der anvendes af både OpenText og NXRG, stiller muligheden for validering af request og responses til rådighed. Det er denne validering, som i stor udstrækning anvendes som validerings mekanisme i NXRG.

Både NXRG og Open Text har det som konfiguration, om sådanne valideringer skal udføres i forbindelse med forespørgsel og svar (request/response) og for de forskellige typer kald (ITI-42, ITI-61, ITI-57 og ITI-18).

Følgende tabel viser, hvordan denne konfiguration af validering er sat op for nuværende NXRG og tidligere anvendte Open Text:

2.1.3.1.2. Sammenligning af patientId'er

Ved validering af forespørgsler skal der sammenlignes patientId'er. Ifølge specifikationen skal denne sammenligning tage højde for sammensmeltning af patientId'er (This comparison shall take into consideration patient identity merges as described in ITI TF-2a: 3.8.4.2.4.). I NXRG er det antaget, at denne form for sammensmeltning ikke forekommer, og sammenligning af patientId'er er derfor implementeret ved simpel strengsammenligning.

2.1.3.1.3.  Validering af ITI-18 fremsøgning response

Da Open Text var registry, var der ikke request (input) validering på oprettelses kalende (ITI-42 og ITI-61). Derfor er der herfra fejlbehæftet metadata, som ikke overholder IHE standarden. Når der laves en fremsøgning (ITI-18), og bare eet af disse dokumenter er imellem, vil kaldet gå i fejl, og ingen af dokumenterne blive returneret. 

For at undgå denne situation er, er der i NXRG lavet sådan, at hvert dokuments metadata, der returneres fra fremsøgningen, valideres for sig selv. De dokumenter, som fejler i valideringen, returneres ikke i resultatsættet. Der indsættes istedet for disse en fejl linie i svaret, ligesom dokumentet logges til applikations loggen. Dokumentet identificeres her ved entryUuid.  Er der sådanne frasorteringer i fremsøgning sættes status til Partial success, og hvis alle fremsøgte dokumenter frasorteres sættes status til Failure.

2.1.4. Databaselag

NXRG har behov for at persistere data i en database. NXRGs datamodel er realiseret udfra følgende principper:

• Muligt at udvide med nye querytyper, hvis dette skulle ønskes senere
• Muligt at implementere en passende migreringsstrategi for data i det gamle NSP XDS Registry uden tab eller forvansking af data

For en detaljeret beskrivelse af databasemodellen se afsnittet nedenfor.

2.1.5. XDSCleanup service

De data, der opbevares i NXRG, skal slettes efter noget tid. Hvor lang tid der er tale om, kommer an på typen af data. Til at afgøre denne klassifikation anvendes metadata-attributten typeCode (den består af to komponenter: en typeCode-kode og en typeCode-scheme) på DocumentEntry.

Foreløbigt gælder følgende regler:

• Aftaledokument (Typekode: 56446-8): Skal slettes efter 2 år

Sletning varetages af den separate service XDSCleanup. Der henvises til dokumentationen for denne service for en beskrivelse af reglerne for, hvordan og hvornår sletning af dokumentmetadata finder sted.

2.1.6. Eksterne services

Der er i dag eksterne services, der tilgår OpenText Registry direkte (dvs udenom de i forgående afsnit skitserede NSP services).

Det drejer sig om følgende:

• KIH Repository

De fleste andre eksterne services (f.eks. PLSP, Bookplan, Laboratoriesvarportalen) udbyder data ved selv at udstille XDS Registry+XDS Repository snitflader, som Dokumentdelingsservicen så integrerer med. Ændringer i det nationale registry vil ikke berøre disse typer.

2.1.6.1. KIH Repository

KIH databasen (repository) indeholder dokumenter af typerne PHMR og QRD dvs hjemmemålinger og spørgeskemabesvarelser. KIH Repository anvender det nationale registry til at få indexeret disse dokumenter og gøre dem søgbare via Dokumentdelingsservicen.

KIH databasen kalder således ITI-42 på det nationale registry. Der er to muligheder i fremtiden:

1. KIH kalder direkte på NXRG ITI-42: Denne løsning er tilsvarende det, der sker i dag
2. KIH kalder DROS ITI-42: DROS ventes at komme til at indeholde valideringer, der vil øge kvaliteten af de metadata, der i sidste ende havner i det nationale registry. Ved at lade KIH anvende denne snitflade vil KIH metadata blive underlagt samme valideringer. NB ITI-42 på DROS findes både i en DGWS og en ikke-DGWS (IP whitelisting eller SDN aftale) udgave. For KIHs vedkommende vil det være relevant at kalde ikke-DGWS snitfladen for at undgå snitfladeændringer.

Inden driftsstart for NXRG skal det afklares, hvilket af de to punkter ovenfor, der ønskes.

Derudover skal der udarbejdes en plan i samarbejde med Medcom om, hvordan det skal foregå.

2.2. Afvigelser fra IHE XDS standarden

I forhold til NXRG, så er det ikke hele IHE XDS specifikationen, der implementeres. I de følgende afsnit dokumenteres evt. fravalg og beslutninger ved de enkelte services.

2.2.1. ITI-18: Registry Stored Query

I forhold til fremsøgning, så er det besluttet, at følgende query typer skal understøttes:

• FindDocuments
• FindDocumentsByReferenceId
• GetDocuments

Dog forholder det sig sådan, at "FindDocumentsByReferenceId" ikke understøttes af DDS'en og dermed kan den i praksis ikke kaldes. Der anses ikke for nuværende behov for at ændre dette.

Når man laver en fremsøgning med ITI-18, kan man få to typer af objekter tilbage, baseret på den retur type man sætter i kaldet. 

• LeafClass: her returnes en liste af matchende documentEntry med fuld metadata
• ObjectRef: her returnes en liste af objekt referencer, som entryuuid

En måde at fremsøge meget store datamængder på, kan derfor laves med først en fremsøgning retur type ObjektRef og efterfølgende anvende disse værdier til at lave en GetDocuments med retur typen LeafClass.

DDS'en understøtter dog ikke "ObjectRef" retur typen, og der anses ikke for nuværende behov for at ændre dette. En detalje ved returnering af objekt referencer er, at man ikke vil kunne lave spærringer på dokumenter alene på disse. Men det vil kunne ske efterfølgende når id'erne anvendes i en GetDocuments og metadata faktisk hentes frem.

2.2.2. ITI-57: Update Document Set

Specifikationen beskriver i afsnit "3.57.4.1.3.4 Patient ID Reconciliation", hvordan det skal håndteres, hvis patient-id opdateres som en del af et kald til ITI-57. I forhold til NXRG, så har vi valgt, at denne ikke skal understøtte dette, hvorfor et forsøg på ITI-57 kald, hvor patient id opdateres vil resultere i en fejl til anvenderen.

Patient ID Reconciliation vil resultere i øget kompleksitet i NXRG, og anvendere vil kunne opnå det samme ved f.eks. at deprecate eksisterende data på en patient, og dernæst oprette data på en anden.

Derudover vil anvendelsen af NXRGs ITI-57 service ikke foregå direkte men via DROS - Guide til anvendere. I forhold til auditlogning og diverse tjek, så er de fleste NSP anvender services tænkt til en brug, hvor der er netop én patient i kontekst ad gangen.

Vi vurderer, at skift af patient ID vil skabe øget unødvendig kompleksitet i de anvenderrettede services.

2.3. Andet væsentlige at notere for design af NXRG

2.3.1. ITI-57 Update metadata

Dette kald tillades ikke for OnDemand dokumenter. Det anvendte biblioteks fra Open eHealth afviser typen OnDemand i forbindelse med opdatering af metadata. Det fungerer sådan for både Open Text registry og NXRG.

2.3.2. ITI-61 replace document

Dette kald opfører forskelligt for Stable og OnDemand dokumenter. Ved replace af Stable dokument deprecates de gamle dokument. Dette sker ikke for onDemand dokumenter. Der er i ovenstående specifikationen ikke nævnt noget med status ændring for OnDemand  Det fungerer sådan for både Open Text registry og NXRG.

2.3.3.  ITI-42 Register document set

For dette kald, tillades 'replay' requests. Dvs. hvis servicen modtager to gyldige identiske requests, vil den i begge tilfælde give succes svar, selvom dataen kune gemmes første gang.

To requests anses dog kun som identiske hvis alle elementer har et gyldigt entry uuid. Hvis ikke, genererer servicen nye entry uuid'er, og de to requests bliver dermed forskellige.

2.3.4. Håndterede type koder (type codes)

NXRG kan konfigureres med en liste af type codes, sådan at en instans håndtere en eller flere type koder. Dette resulterer i følgende opførsel

• ITI-18 Registry Stored Query: hvis typecode indgår i søge parametrene og ingen af dem håndteres, returneres et tomt kald. Ellers udføres søgningen.
• ITI-42 Register document set: hvis typecode indgår i dokumentets metadata (documententry) og den ikke håndteres afvises kaldet med en fejl.
• ITI-61 Register on demand document:  hvis typecode indgår i dokumentets metadata (documententry) og den ikke håndteres afvises kaldet med en fejl.
• ITI-57 Update metadata:  hvis typecode indgår i dokumentets metadata (documententry) og den ikke håndteres afvises kaldet med en fejl.

2.4. Databasemodel

Modellen nedenfor viser to databaser: Metadata, som er den database der vedligeholdes og ejes af NXRG, og Dokumenter, som er den database der vedligeholdes og ejes af OpenXDS. 

xDB indeholder således metadata for det centrale registry, hvorimod mariaDB indeholder dokumenterne i repository.

* Hver kasse i ovenstående diagram har en kort forklaring, som kommer frem i et nyt browservindue, når der klikkes på kassen.

Datamodellen er opbygget med udgangspunkt i følgende overordnede principper:

1. Understøtte MVP: NXRG er startet som et Minimal Viable Product med intentionen om senere at kunne skifte til et andet mere modent produkt. Dette betyder, at modellen ikke skal være mere kompliceret, end højst nødvendigt.
2. Kunne understøtte udvidelser af NXRG: Selvom kravene (MVP) fra starten er begrænsede, så giver det mening at overveje, at det skal være muligt at udvide NXRG f.eks. med flere ITI-18 query typer. Datamodellen skal i denne sammenhæng være robust over for denne slags ændringer (dvs det skal være velforstået, hvad sådanne udvidelser betyder i forhold til databasemodellen).
3. Understøtte migrering: Da en væsentlig del af MVP indeholder migrering af data fra OpenText Registry til NXRG, så skal databasemodellen være lavet på en måde, således at migreringen er understøttet.
4. Driftsvenlig: Det skal være muligt for driften at foretage opgaver i forbindelse med support og drift (f.eks. oprydningsjob)

I det følgende beskriver vi datamodellen for NXRG og beskriver, hvorledes ovenstående principper er respekteret. Datamodellen præsenteres først i overbliksform i nedenstående E/R-diagram, og de enkelte tabeller beskrives derefter.

Hver entitet i diagrammet svarer til en tabel. 

De vigtigste entiteter er Association, DocumentEntry, Folder og SubmissionSet, som er NXRG's repræsentation af de tilsvarende begreber fra IHE-specifikationen. I det følgende kaldes disse fire tabeller for objekttabeller. En række i en objekttabel svarer til et tilsvarende objekt, f.eks. svarer en række i Association-tabellen til et Association-objekt, en række i DocumentEntry-tabellen til et DocumentEntry-objekt, osv. Disse tabeller indeholder de attributter som der er brug for, for at NXRG kan realisere sine snitflader. Tabellerne er dog ikke fulstændige modeller af de objekter, de repræsenterer, da det er ganske omfattende at udarbejde og vedligeholde en sådan datamodel. De fulde objekter gemmes i stedet som xml i en tilhørende *Content-tabel (i det følgende kaldet en indholdstabel).

Objekttabellerne indeholder de attributter der er nødvendige for at understøtte søgning gennem ITI18-snitfladen, samt for at tjekke forretningsregler i ITI42-, ITI57- og ITI61-snitfladerne. Indholdstabellerne indeholder selve objekterne i et xml-format, der er nemt at parse og serialisere, men besværligt at søge i.

Alle tabellerne har felterne creation_time og last_update_time, der indeholder tidspuntk for oprettelse henholdsvis ændring.

Tabellen fieldmigrationstatus indeholder ikke registry relateret data, men er en "arbejdstabel", der anvendes til at holde styr på, hvor langt potentielle felt migreringer er (se afsnit "felt migrering" nedenfor).

2.4.1. Association

2.4.2. AssociationContent

2.4.3. Author (documententry_author)

2.4.4. Code (documententry_eventcode og documententry_confidentialitycode)

2.4.5. DocumentEntryContent

2.4.6. DocumentEntries

2.4.7. Folder

2.4.8. FolderContent

2.4.9. ReferenceId (documententry_referenceid)

2.4.10. SubmissionSet

2.4.11. SubmissionSetContent

2.4.12. Deleted_Documententries

2.4.13. Fieldmigrationstatus

Denne tabel, skal indeholde en række for hver type felt migrering, som skal laves. Rækkes indsættes i forbindelse med at database scriptene bliver kørt i forbindelse med opgraderinger. Og opdateres af "felt migrerings servicen".

Alle tider er tider er databasens tidszone.

2.4.14.  Documententries_status90_deletion

3. Migrering af data

Den oprindelige data migrering fra openText registry er ikke længere aktuel, og indholdet er flyttet til "Yderligere dokumentation - Migration"

3.1. Felt migrering

På tidspunktet for NXRG tilblivelse blev der udvalgt en række felter fra kaldets metadata (XMl baseret RIM format), som var interessante som søgbare felter. Disse felter, gemmes som selvstændige felter i tabeller som documententries og referenceid. Der opstår siden behov for at få flere af disse felter trukket ud af XML formatet. Dvs. der i princippet skal køres en migrering af eksisterende metadata for at trække disse felter ud. Dette er lavet som en selvstændig service. Source koden ligger sammen med resten af NXRG, men servicen starter op selvstændig og aktiveres ved at tilgå et specifik endpoint. Detaljerne er beskrevet i "NXRG - driftvejledning til felt migrering".

Som ovenstående figur viser, består felt migreringen af 3 trin:

1. udvidelse af databasemodel. Her tilføjes det søgbare felt databasen og NXRG justeres sådan at nye dokumentregistreringer vil gemme feltet, som et søgbart felt.
2. migrering af data. Denne kan foregå af flere omgange (batch) da kørslen kan være tidskrævende. Servicen konfigureres med en batch størrelse, som det antal dokumenter, der håndteres i en enkelt kørsel.
3. anvendelse af det søgbare felt. Når alt data er migreret kan det nye felt tages i anvendelse. Dvs først her kan ny funktionatlitet, der gør brug af feltet, udvikles.