Versions Compared

Key

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

...

Table of Contents

Introduktion

Formål

MinSpærring Samtykkeservicen servicen er en national service til administration og verifikation af en borgers samtykke og spærringer for sundhedsfagliges adgang til data i nationale systemer.

Formålet med dette dokument er beskrive arkitektur og design i MinSpærring servicenSamtykkeservicen.

For et overblik over systemet se afsnittet "Overblik over løsningen".

...

VersionDateResponsibleDescription

1.0

29.06.2012

Systematic

First edition

1.1

28.11.2014

Systematic

References to National Patient Index (NPI) removed

1.2

25.11.2016

Systematic

MinLog now reuses SOSI ID-card and no longer requires HSUID (5.4)

1.3

7.2.2017

Systematic

Added handling of data specific consent by precautionary principle to section 5.3.1.

1.4

13.06.2018

Systematic

Migrated to NSPOP SVN


23.10.2018KITDocument moved from Word to Confluence. Original document name was: SDD0011 Consent Services Architecture and Design.docx

14.05.2020KITSDS-3883 Etablering af IDWS snitflade

09.11.2020KITSDS-3685 Min Spærring skal anvende SORES til SOR-SHAK opslag

12.11.2020KITOversættelse til dansk

06.05.2021KIT[SDS-2416] MinSpærring  Samtykkeservicen skal ændres til at kalde minlog2

...

ReferenceBeskrivelse

Behov

National consentservice, v1.1 (behovsbeskrivelse for Min Spærring Service)

Data Model

MinSpærring Samtykkeservicen- Data Model

Administra Service Interface Beskrivelse

MinSpærring Samtykkeservicen- Administration Service Interface Description


Verifikation Service Interface Beskrivelse

MinSpærring Samtykkeservicen- Verifikation Service Interface Beskrivelse

Driftsvejledning

MinSpærring Samtykkeservicen- Driftsvejledning

MinLog

MinLogProvider

UdviklerGuide


MinSpærring Samtykkeservicen- Guide til Udviklere


HSUID-Header

MinSpærring Samtykkeservicen- Healthcare Service User Identification Header Interface Description

Sundhedsloven

LBK nr 913 af 13/07/2010 (Sundhedsloven) https://www.retsinformation.dk/forms/r0710.aspx?id=130455

Ændring af sundhedsloven

LOV nr 605 af 14/06/2011 (Lov om ændring af sundhedsloven)

https://www.retsinformation.dk/forms/r0710.aspx?id=137609

...

Samtykkeservicen

Baggrund

Grundlaget for samtykke service er som følger::

...

Web Service for registration and lookup / control of consent information.”

Kravene, som MinSpærring skal Samtykkeservicenskal opfylde, er uddybet i [Behov]. Det juridiske grundlag er beskrevet i [Sundhedsloven] med rettelser givet i [Ændring af sundhedsloven].

Overblik over løsningen

MinSpærring Samtykkeservicen udstiller to services. Det er MinSpærring Samtykkeservicen Administration og MinSpærring Samtykkeservicen Verifikation.


HTML
<iframe src="https://archi.nspop.dk/NSP/570928ca/views/ba962f9c-58fb-40ba-92cc-a7d065936542.html" name="test" height="570" width="800">You need a Frames Capable browser to view this content.</iframe>   

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

...

Samtykkeservicen Brugertyper

Der findes følgende brugertyper i Minspærring:

...

Brugertypen: BorgerVerifikationMapning til MinSpærring Samtykkeservicen ServiceActor
SecurityContextTicketAudienceMatche audience som findes som konfiguration i Minspærring


ValidityEr valid

Message
Verificeres ikke - må gerne være der

ActingUserUserTypeSkal være CitizenBrugertypen: Borger


IdentifierFormatSkal være CPR


IdentifierSkal være satactionUserCpr


GivenNameVerificeres ikke - må gerne være der


SurNameVerificeres ikke - må gerne være der


CredentialsVerificeres ikke - må gerne være der


PersistentUniqueKeyVerificeres ikke - må gerne være der

PrincipalUser
Må ikke være der

Organisation
Må ikke være der

ClientNameVerificeres ikke - må gerne være dersystemName
Brugertypen: SundhedsfagligVerifikationMapning til MinSpærring Samtykkeservicen ServiceActor
SecurityContextTicketAudienceVerificeres ikke - må gerne være der


ValidityEr valid

Message
Verificeres ikke - må gerne være der

ActingUserUserTypeSkal være HealthCareProfessionalBrugertypen: Sundhedsfaglig


IdentifierFormatSkal være CPR


IdentifierSkal være satactionUserCpr


GivenNameVerificeres ikke - må gerne være der


SurNameVerificeres ikke - må gerne være der


Credentials.NationalRoleMå ikke være der


PersistentUniqueKeyVerificeres ikke - må gerne være der

PrincipalUser
Må ikke være der

OrganisationIdentifierSkal være derorganisationIdentifier


identifierFormatSkal være der og skal være CVR

ClientNameVerificeres ikke - må gerne være dersystemName
Brugertypen: AdministrativVerifikationMapning til MinSpærring Samtykkeservicen ServiceActor
SecurityContextTicketAudienceVerificeres ikke - må gerne være der


ValidityEr valid

Message
Verificeres ikke - må gerne være der

ActingUserUserTypeSkal være HealthCareProfessionalBrugertypen: Administrativ


IdentifierFormatSkal være CPR


IdentifierSkal være satactionUserCpr


GivenNameVerificeres ikke - må gerne være der


SurNameVerificeres ikke - må gerne være der


Credentials.NationalRoleSkal være der - og skal matche config variable i MinSpaerring


PersistentUniqueKeyVerificeres ikke - må gerne være der

PrincipalUser
Må ikke være der

OrganisationIdentifierSkal være derorganisationIdentifier


identifierFormatSkal være der og skal være CVR

Client
Verificeres ikke - må gerne være dersystemName
Brugertypen: SystemVerifikationMapning til MinSpærring Samtykkeservicen ServiceActor
SecurityContextTicketAudienceVerificeres ikke - må gerne være der

Message
Verificeres ikke - må gerne være der

ActingUser
Må ikke være derBrugertypen: System

PrincipalUser
Må ikke være der

OrganisationIdentifierSkal være derorganisationIdentifier


identifierFormatSkal være der og skal være CVR

Client
Verificeres ikke - må gerne være dersystemName

...

En systembruger giver ikke mening i sig selv i forhold til de beskrevne brugerhistorier. Systembrugeren er der kun således at systemer (i praksis sundhed.dk) kan anvende MinSpærring Samtykkeservicen og ved hjælp af en medsendt HSUID header kan opnå status som een af brugertyperne Borger eller Sundhedsfaglig. 

...

Brugertypen Borger (sundhed.dk)

VerifikationMapning til MinSpærring Samtykkeservicen ServiceActor

HSUID Header

userType
Skal være der og skal være CITIZEN

Brugertypen: Borger



actingUserCivilRegistrationNumber


Skal være sat

actionUserCpr


responsibleUserCpr


Må ikke være sat eller være anderledes end actingUserCivilRegistrationNumber



systemName


Verificeres ikke - må gerne være der

systemName (prefix)


systemVersion


Verificeres ikke - må gerne være der

systemName (postfix)

Brugertypen Sundhedsfaglig (sundhed.dk)

VerifikationMapning til MinSpærring Samtykkeservicen ServiceActor

HSUID Header

userType
Skal være der og være HEALTHCAREPROFESSIONAL

Brugertypen: Sundhedsfaglig


actingUserCivilRegistrationNumber


Skal være sat

actionUserCpr


responsibleUserCpr


Må ikke være sat eller være anderledes end actingUserCivilRegistrationNumber



orgUsingIDType


Verificeres ikke - må gerne være der

healthcareOrgType


orgUsingIDName


Verificeres ikke - må gerne være der

healthCareOrg


systemName


Verificeres ikke - må gerne være der

systemName (prefix)


systemVersion


Verificeres ikke - må gerne være der

systemName (postfix)

...

Samtykkeservicen Administration

Allows registration and maintenance of submitted consents for the citizen. The service expose the following operations

...

  • ConsentRegistrationsGet – Returnerer alle registreringer for en borger.

  • ConsentAdd – Opretter en ny spærringer eller samtykke for en borger. Et registrering er defineret i MinSpærring Samtykkeservicen - Data Model og indeholder:

    • Type (samtykke eller spærring)

    • Hvad det gælder

    • Hvem det gælder for

    • Gyldighedsperiode

...

Nogle operationer tillader at bruger og borger ikke er den samme person. Hvis de ikke er den samme person logges handling til borgerens MinLog.

MinSpærring Samtykkeservicen Administration opbevarer i sin database information om samtykke og spærring, som angivet af ConsentAdd ovenfor, ud over oplysninger om, hvem og hvornår samtykke henholdsvis oprettes og ændres.

...

Samtykkeservicen Verifkation

Servicen anvendes til at verificere spærringer og samtykker mellem border og sundhedsfaglig. Service udstiller nedenstående operationer:

...

For sundhedsfaglige er det nedenstående beslutningstræ der anvendes til at lave MinSpærring Samtykkeservicen Verifikation:

Gliffy Diagram
macroIdd54356ae-900b-4792-b5d3-dd7011d9e504
nameVerifikation
pagePin1

...

Database og service deployment overblik

MinSpærring Samtykkeservicen data lagres i en central database, der replikeres til de forskellige NSP instanser.

...

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


MinSpærring Samtykkeservicen Administration installeres på en central server og eksponeres på NSP-forekomster gennem afkoblingskomponenten DCC. Proxyen for MinSpærring Samtykkeservicen Administration, der bruges i en NSP-instans, implementeres ikke som en del af denne service. Proxyen oprettes på NSP i form af en konfiguration af DCC.

MinSpærring Samtykkeservicen Verifikation er kun installeret på cNSP og forespørger på den lokale database.

...

Servicekonfigurationen udføres i to (tre for MinSpærring Samtykkeservicen Administration) forskellige property filer, der leveres som en del af docker setup.

...

For beskrivelse af konfigurationen se MinSpærring Samtykkeservicen - Driftsvejledning.

Applikations konfiguration

...

Service klient konfiguration

MinSpærring Samtykkeservicen Administration service skal være i stand til at kommunikere med Min Log'-tjenesten, og konfigurationen af den anvendte serviceklient skal også udføres i en konfigurationsfil.

...

Database konfiguration

Begge MinSpærring Samtykkeservicen services skal forsynes med en datasource med navnet 'ConsentServiceDS', der har adgang til den database der er beskrevet i MinSpærring Samtykkeservicen - Data Model.

Begge tjenester skal have adgang til en datasource med navnet 'WhitelistDS', der bruges af whitelist af anvendersystemer.

Beslutninger angående Web Services

De to MinSpærring Samtykkeservicen services er udviklet med en ”Java-first” tilgang, hvor Java-koden er udviklet uafhængigt, og WSDL genereres på tidspunktet for kørsel på webserveren på basis af den implementerede kode.

...

Web Service operationerne består af: en Medcom-header, en sikkerheds-header, en HSUID-header MinSpærring Samtykkeservicen - Healthcare Service User Identification Header Interface Description og et body-element.

I MinSpærring Samtykkeservicen Administraition bruges indholdet af HSUID-headeren til at autentificere og validere autorisationen for den kalende bruger ud over at validere, at brugeren har lov til at kalde metoden med de inkluderede parametre i body elementet.
Desuden bruges det 'fungerende bruger'-felt i HSUID-headeren til at indstille felterne' oprettet af' og' modificeret af' på en spærring/samtykke samt for at vurdere om det skal logges at en registrering er oprettet/rettet af en anden borger end den registreringen berører.

Ved MinSpærring Samtykkeservicen Verifikation er kun gyldigheden af ​​HSUID-headeren valideret.

...

Alle andre parametre for kald til servicen er indeholdt i SOAP body elementetm for hvilket indhold varierer med hensyn til den enkelte operation (se MinSpærring Samtykkeservicen - Administration Service Interface Description og MinSpærring Samtykkeservicen - Verifikation Service Interface Beskrivelse).

Beslutninger vedrørende service arkitektur

...

Beslutninger vedrørende data sources

MinSpærring Samtykkeservicen databasen implementeres gennem Hibernate, hvilket gør det muligt at afkoble databashåndteringen fra koden. Datasource til MinSpærring Samtykkeservicen håndteres gennem injektion fra EJB-containeren i applikationsserveren.

...

Datamodelen er dokumenteret i MinSpærring Samtykkeservicen - Data Model.

Arkitektur

Dette afsnit beskriver både statiske og dynamiske aspekter af systemarkitekturen, herunder grundlaget for de individuelle designvalg.

...

SLA-log-interceptor er ansvarlig for SLA-logning af alle servicekald.

Fejlhåndtering

MinSpærring Samtykkeservicen Administration og MinSpærring Samtykkeservicen Verifikation håndterer fejl forskelligt. Se underafsnittene "Fejlhåndtering" i de følgende to sektioner.

Service Logik

...

Samtykkeservicen Administration

Servicelogikken implementeres direkte i bønneimplementeringen, da logikken primært består i videresendelse af opkald til DAO'en. Derudover udføres samlet validering af HSUID-overskriften ud over validering af, at sundhedspersonale kun har tilladelse til at kalde 'ConsentAdd' -metoden. Det tjekkes ved kald af cprexists-servicen, at det cpr-nummer som forespørgslen indeholder er gyldigt.

...

Det sikrer desuden, at potentielle fejl er logget i fejlloggen og udfører fejllogning af flow-id.

Service Logik for

...

Samtykkeservicen Verifikation

Servicelogikken overholder beslutningsgrafen, der er lavet til godkendelsesbekræftelse (se tidligere afsnit), og den implementeres i klassen ConsentVerificationServiceLogic.

MinSpærring Samtykkeservicen Verifikation

Verifikationen består af tre forskellige operationer: brugerverifikation, dataverifikation og verifikation af udenlandske sundhedspersonale.

...

For en beskrivelse af byggeprocessen og eksterne / interne afhængigheder for servicen se MinSpærring Samtykkeservicen - Guide til Udviklere.

Testspecifikationer

To be able to test the consent administration service, the Min Log-service must be available. It is also possible to test consentadministrationsservicen with a stub for Min Log.

Min Log-tjenesten skal være tilgængelig for at kunne teste MinSpærring Samtykkeservicen Administration. Det er også muligt at teste MinSpærring Samtykkeservicen Administration med en stub til Min Log.

...

Der findes en række klasse med  MinSpærring med  Samtykkeservicen Administration integrationstest. De findes alle i modulet consent-administration-integrationtest.

...

MinLog-klassen sikrer, at serviceloggingsmekanismen ved hjælp af MinLog implementeres korrekt.

MinSpærring Samtykkeservicen Verifikation

Der findes en række unit tests til MinSpærring Samtykkeservicen Verifikation. Disse findes alle i modulet consent-verification-app.

...