Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootFacade (GM-Facade) - Leverancebeskrivelse


Indholdsfortegnelse

Table of Contents

Introduktion

Formål

Denne guide har

...

til formål at give et overblik over Graviditetsmappens

...

facade (GM-Facade) med henblik på at intern anvender kan tilgå GM-Facaden og udstille data fra Graviditetsmappen. Formålet med dokumentet er at give

...

overblik over løsningen, samt indsigt i krav til OpenID Connect (OIDC), proces for whitelisting, samt

...

Beskrivelse

...

adgangs- og testforudsætninger. 

Beskrivelse

GM-Facaden er en FHIR-baseret komponent, som udstiller data fra Graviditetsmappen via NMHD komponenten (Generisk udstilling (MHD) - Leverancebeskrivelse). NMHD servicen er en generisk service, som har til formål at udstille data hentet fra dokumentdelingsservicen via en generisk FHIR-snitflade. Adgangen styres via NSP’s sikkerhedskomponenter (Accesshandler, STS) med Triforks OIDC som er godkendt af SDS (Sundhedsdatastyrelsen) og whitelisted i de relevante komponenter.

Image Added


Definitioner og referencer

Reference / termBeskrivelse
GM FacadeGraviditetsmappens app facade
OIDCOpenID Connect – standard for identitets- og adgangsstyring.
JTP-H

Joint Trust Profile for Health – dansk profil for anvendelse af OIDC i sundhedsdomænet.

JWT Token Profile for Healthcare (se NSP Access Handler - Design og arkitekturbeskrivelse

FHIR

FHIR står for Fast Healthcare Interoperability Resources.

Det er en standard udviklet af HL7 (Health Level 7) til elektronisk udveksling af sundhedsoplysninger.

NSISNational Standard for Identiteters Sikringsniveau.
SDSSundhedsdatastyrelsen – ansvarlig for godkendelse og whitelisting af OIDC.
NMHD

National Mobile Health Data – komponent i NSP-infrastrukturen.

MHD  = Mobile Access to Health Documents

STSSecurity Token Service – håndterer sikkerhedstokens i NSP.
AccesshandlerNSP-komponent, der kontrollerer adgang til GM-Facaden.


Relevante use-cases

Pt. er det kun borgeren selv der kan hente data via. denne GM Facade.

Læsevejledning og forudsætninger

Denne guide henvender sig til tekniske anvendere (udviklere, arkitekter), som skal integrere med GM-Facaden via NSP.
Læsere bør have kendskab til:

  • OIDC og JTP-H-profilen

  • FHIR-standarder

  • NSP’s sikkerhedsarkitektur (STS, NMHD, Accesshandler)

Links til mere information

Dokumentation for anvendt FHIR model findes her: https://build.fhir.org/ig/trifork/gm-fhir-ig/branches/main/index.html

Dokumentation for krav til JTP-H findes her: NSP Access Handler - Design og arkitekturbeskrivelse 

Grafisk fremstilling og sammenhængen

<Tegning(er) der letter forståelsen og beskrivelser af relevante sammenhængen>

Relevante use-cases

Pt. er det kun borgeren selv der kan hente data via. denne GM Facade.

Læsevejledning og forudsætninger

Dette dokument er henvendt til udviklere og arkitekter, der skal anvende GM Facade.

Tilslutningsaftale – Bestillingsark for adgang til eksternt testmiljø

Bruno Collection – NMHD – NSP Mobile Access to Health Documents

Bruno Collection - GM-Facade 

FAQ NSP miljøer - NSP services - Global Site


Sikkerhed

Adgangen sker gennem NSP’s sikkerhedskomponenter og følger JTP-H-profilen, hvor borgeren logger ind med MitID, og et OIDC-token ved kald til GM-Facaden.

Sikkerheden i GM-Facaden bygger på OIDC og NSIS (National Standard for Identiteters Sikringsniveau).

  • Alle OIDC-udbydere skal opfylde NSIS niveau "Betydelig" og  OIDC’er godkendt af SDS må benyttes. Internt benyttes Triforks OIDC

  • Whitelisting i Accesshandler og STS er påkrævet, før adgang kan gives.


ForholdForklaring

...

Service udstil typeREST med
JTPH
JTP-H bearer token.
Krævet sikkerhedsniveau
Krævede adgangeBorger-login via JTP-H (JTP-H token identificerer borgeren, der har adgang til egne dokumenter)
OIDCOIDC (skal godkendes og whitelistes af SDS)
WhitelistingKræves for ny OIDC (konfigureres i Accesshandler, STS, NMHD)
Sikkerhedsniveau

NSIS Betydelig 

Data udstilles kun til borgerlogin, og kun borgerens egne dokumenter.

Pt. kun borgeradgang

LogningStandard adgangslog via NSP Access Handler

...

Adgang, brug og

...

FHIR står for Fast Healthcare Interoperability Resources.

Det er en standard udviklet af HL7 (Health Level 7) til elektronisk udveksling af sundhedsoplysninger.

snitflader

Adgang sker ved, at borgeren logger ind og får udstedt et JTP-H token fra en OIDC-udsteder. Dette token anvendes som bearer token i REST-kaldet mod GM-Facaden og giver kun adgang til borgerens egne dokumenter

...

Adgang

Adgang til servicen sker ved at medsende en Authorization-header med bearer token i form af JTP-H. Et gyldigt JTP-H token til test kan erhverves vha. OATH 2.0 med følgender properties:  


Snitfladebeskrivelse og brug

GM-Facaden tilbyder FHIR-baserede endpoints til hentning af journaldata for borgere i graviditetsforløb.
Adgangen sker via NSP’s sikkerhedskomponenter, hvor anvenderen kalder GM-Facaden med et autoriseret JTP-H-token udstedt af en godkendt OIDC.

Et gyldigt token angiver altid borgeren, der er logget ind via MitID, og GM-Facaden returnerer udelukkende data for denne borger.

Adgang til servicen sker ved at medsende en Authorization-header med bearer-token i form af JTP-H.

Hent Journal for borger

Endpoint:

FeltBetydning
Endpoint

<serverurl>/gmaf/api/2025/06/25/journal

Viser formatet på GM-Facadens endpoint. Det er det REST-endpoint, som tredjeparts borgervendte anvendere kalder, når de skal hente borgerens data fra Graviditetsmappen.

Beskrivelse af services
Returnerer borgeren (som

Servicekaldet returnerer den borger, der er angivet i JTP-H

) journaldata vedrørende GraviditetsmappenResultatDokumenttyperne Svangerskabsjournal, vandrejournal og Målinger

Snitfladebeskrivelse og brug

Hent journal for borger

Hent Journal

-tokenet – dvs. borgerens egne graviditetsrelaterede journaldata.

(Selve indholdet af FHIR dokumentet afhænger af det borgertoken der videresendes fra BFF'en)

Resultat

Angiver hvilke dokumenttyper servicen returnerer:
• Svangerskabsjournal (PRF)
• Vandrejournal (PSCR)
• Målinger (PMR)



Kald til servicen: 

Henter borgers journal i Graviditetsmappen : 

GET <serverurl>/gmaf/api/2025/06/25/journal 

Når endpointet kaldes eksempelvis i test  "https://test1-cnsp.ekstern-test.nspop.dk:8443/gmaf/api/2025/06/25/journal" så returneres der et FHIR dokument.Henter borgers journal i Graviditetsmappen 


GET  <serverurl>/gmaf/api/2025/06/25/journal
HeaderValueBeskrivelse
Authorization
Bearer
: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIySWh5aEM4Y1o3WEtmVm1BVG53Wnpxam00THFwMWFnN000d3UyTjNLVGtzIn0.eyJleHAi....
 <JTP-H token>

Header med JTP-H-token udstedt af en SDS-godkendt OIDC. Tokenet identificerer borgeren og anvendes til autorisering via NSP Accesshandler.


Returneret data: 

Endpointet returnerer JSON, der følger implementerings-guiden for dokumenttyperne
Svangerskabsjournal (PRF), Vandrejournal (PSCR) og Målinger (PMR)Endpointet returner et JSON svarende til IG'en
(se FHIR-IG:
https://build.fhir.org/ig/trifork/gm-fhir-ig/branches/main/index.html

<snitflade 2, osv., med request/response>

Generelle koder, værdier, etc.

<Angiv eventuelle generelle koder, værdier, etc>

Fejlbeskeder

<Beskrivelse af  fejlbeskeder, og i hvilke situationer man kan forvente at se disse i.

Noter omkring ting som går på tværs af services. Det kan være fejl som optræder generelt og som man skal være opmærksom på.>

Eksempler på request/response

Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.

<eksempel 1 på ..>

Code Block
languagexml
titleEksempel request/response
collapsetrue
<eksempel her>

<mere eksempel>

Test

<beskriv Test muligheder, test-systemer og eventuelle testdata>

Eksempel kode og klient

Eksempel kode

<Eksempel kode. Det er meget lettere at lave sin egen implementering, hvis man kan kigge efter en anden ....>

Code Block
languagexml
titleEksempel kode
collapsetrue
<eksempel her, eller reference andet steds>

Eksempel klient


Detaljeret snitfladebeskrivelse og FHIR profil:

Den fulde tekniske snitfladebeskrivelse og FHIR-profiler for GM-Facaden findes i den officielle Implementation Guide (GM-FHIR-IG):
https://build.fhir.org/ig/trifork/gm-fhir-ig/branches/main/index.html

Her findes beskrivelser af alle FHIR-profiler - inkl de konkrete datatyper og dokumentstrukturer i GM-Facaden

Den fulde oversigt over tekniske artefakter for GM-Facaden findes på artefakter-oversigten i GM-FHIR-IG. Herfra kan du klikke videre til alle relevante profiler, værdilister og eksempler.

https://test1-cnsp.ekstern-test.nspop.dk:8443/gmaf/api/2025/06/25/journal


Endpoints på TEST1 og TEST2: 

https://test1-cnsp.ekstern-test.nspop.dk:8443/gmaf

https://test2-cnsp.ekstern-test.nspop.dk:8443/gmaf

Fejlbeskeder

I fejl-scenarier vises disse fejlkoder:

Fejlkode

Scenarie

Ugyldig sikkerhedsbilletSikkerhedsbillet er ikke gyldig, f.eks., udløbet, forkert audience osv.
Tjenesten skal kaldes med en gyldig sikkerhedskontekstDer er angivet et bearer token
Ingen matchende aktør fundet for sikkerhedskontekstBearer token angiver ikke et gyldigt borgeropslag

Testdata

Følgende brugere har journaldata på Test 1:


CPRBrugernavnBeskrivelse

0708850322

KayaJokumsen

1507939666

Minerva

2911039098

Pouline
0511820464 Malle Sörensen
1404049428Casandra Kant
1710969864SysMathisen
1403879262 TestinnaTermina 
2610087224 

Bitte My Småland 


1408079612 Cirkeline Bublé 

1905839596

DagmarNap
 0904539384AmbraSand
2008902346KimmiKimsen
2108901238MimmiMimsen
2208901234NinniNinsen
2308901428OdaOddsen
 1201664078LivaLiddel


Eksempel kode og klient

Se integrations test i https://git.nspop.dk/scm/com/graviditetsmappens-app-facade.git for eksempel på komplet integration til komponenten.<og hvor det giver mening angiv eventuel eksempel klient, samt hvordan og hvor det eventuelt kan eksekveres>

Dokument Historik

3/4 2025Martin Henriksen/SDSEtablering af dokumentation
1/7 2025Thomas GlæsnerUdfyldt
19/11 2025Kirsten VintherTilrettet