Page History
...
Indholdsfortegnelse
| Table of Contents |
|---|
Se eksempel på udfyldelse på DDS: DDS - Guide til anvendere - NSP services - Global Site
Introduktion
Formål
Denne guide har som formål at give et overblik over <xxx>.
<Denne guide er tilegnet klienter til NSP og specifikt den leverede komponent/service. Denne del skal være tilstrækkelig for en klientleverandør, som skal udvikle aftagersystemer. Heri tilgodeses specielt referencer til andre dokumenter, da en anvender også skal have en bredere forståelse af den anvendte komponent og eventuelle omgivelser.
Det er selvfølgelig også ret væsentligt at template udfyldes udtømmende, herunder i forhold til den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever>
Beskrivelse
<Formål og beskrivelse af komponenten/servicen>
Links til mere information
<Relevante links til andre dokumenter, herunder i forhold til de data services skal arbejde på, og den model de følger>
Graviditetsmappens app facade (GM Facade). Formålet med dokumentet er at give anvendere et overblik over løsningen, samt en oversigt over, hvilke User Stories der er understøttet af GMAF og hvordan disse er implementeret (flows).
Beskrivelse
GM Facade er en REST udstilling af Graviditetsmappens journal data som en FHIR model sikret med JTP-H.
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 <Eventuel link til mere uddybende beskrivelse, intern på NSP og eksternt>
Grafisk fremstilling og sammenhængen
<Tegning(er) der letter forståelsen og beskrivelser af relevante sammenhængen>
Relevante use-cases
<Angiv use cases såfremt det er relevant>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 <> .
Det forventes at læseren har kendskab til <f.eks.: SOAP WebService, Den Gode WebService (DGWS) og Sercurity Token Service (STS), o.a.>
<Eventuel andre forudsætninger>
Sikkerhed
...
GM Facade.
Sikkerhed
| Service udstil type | <Angiv typen, f.eks. DGWS, IDWS, ...> |
| Krævede adgange | <Angiv adgange som er nødvendige for anvendere for at kunne benytte servicen/komponenten> |
| Whitelisting | <Angiv eventuel nødvendig whitelisting> |
| Krævet sikkerhedsniveau | <Angiv krav til authentication for at kunne bruge servicen/komponenten> |
| Forudsætninger for anvendelse | <Angiv forudsæntninger som er nødvendige for at kunne bruge servicen/komponenten, eventuelle nødvendige kald til andre services, etc.> |
| Logning | <Angiv om og hvad der logges> | <evt. yderligere krav eller forhold> |
<Eventuel nærmere introduktion>
<Eventuel yderligere beskrivelse af området / domænet som servicen/komponenten servicerer>.
<Samt yderligere information som er vigtigt for anvendelsen eller forståelsen>
Definitioner og referencer
| REST med JTPH bearer token. | |
| Krævet sikkerhedsniveau | Pt. kun borgeradgang |
| Logning | Standard adgangslog via NSP Access Handler |
Definitioner og referencer
| Reference | Beskrivelse | ||
|---|---|---|---|
| JTP-H | JWT Token Profile for Healthcare | ||
| GM Facade | Graviditetsmappens app facade | ||
| FHIR | FHIR står for Fast Healthcare Interoperability Resources. Det er en standard udviklet af HL7 (Health Level 7) til elektronisk udveksling af sundhedsoplysninger. | Reference | Beskrivelse
Adgang, brug og snitflader
Adgang
<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | <Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.> |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
Snitfladebeskrivelse og brug
<Beskrivelse af Snitfladerne, samt den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever.>
<snitflade 1>
<Beskrivelse af hver snitflade input/output>
...