Indhold
Overblik
Læsevejledning
Dette dokument er rettet mod udviklere, der skal udvikle eller teste services, der har grænseflader mod opslagsservices i IDSAS. Det vil i praksis kun være NSP services.
Snitflader
Til denne type anvender, findes snitfladen til sløringer.
WSDL'en er både udstillet med og uden sikkerheds-headers:
Snitflade | Endpoint | |
---|---|---|
Uden sikkerheds-header | idsas-lookup | <server>/idsas-lookup/20230601/lookup?wsdl |
Med sikkerheds-header | idsas-lookup | <server>/idsas-lookup/service-contract/secure-wsdl/20230601/idsas-lookup.wsdl |
Datoen "2023060"' angiver versionen af snitfladen. Pt. findes kun denne ene version.
Operationer
GetBlurredOrganisations
Denne operation ligger i idsas-lookup snitfladen og benyttes til at hente alle aktive slørringer for en bestemt borger. Dvs. en liste af alle organisationer, der skal sløres for denne borger.
Operationen benyttes i praksis kun af STS'en.
Elementer
GetBlurredOrganisationsRequest
Element | Beskrivelse | Type | Obligatorisk |
---|---|---|---|
patientId | Angiver borgerens ID. | PatientID | Ja |
PatientID
Element | Beskrivelse | Type | Obligatorisk |
---|---|---|---|
id | Angiver borgerens ID (CPR-nummer uden bindestreg). | string | Ja |
classification | Typen af ID. Gyldige værder er: 'CPR' | string | Ja |
BlurredOrganisationsResponse
Element | Beskrivelse | Type | Obligatorisk |
---|---|---|---|
organisationId | ID på organisation (vilkårligt antal) | OrganisationID | Ja |
OrganisationID
Element | Beskrivelse | Type | Obligatorisk |
---|---|---|---|
id | Angiver organisationens ID | string | Ja |
classification | Typen af ID. Gyldige værdier er: 'CVR' | string | Ja |
Eksempler
Understøttelse af brugerhistorier
Brugerhistorie | Udførsel |
---|---|
Hente CVR-numre, der skal sløres | Udføres ved at kalde GetBlurredOrganisations. |
Fejlbeskeder
Fejlbesked | Noter |
---|---|
Client persistent unique key '%s' er ikke whitelisted for type SALT | Hvis en given client persistent unique key ikke er whitelisted for GetCurrentSalt operationen, gives denne fejlbesked. |
Brugertypen kan ikke bestemmes ud fra den medsendte sikkerhedsbillet | Denne fejl gives, hvis indholdet i sikkerhedsbilletten hverken matcher "sundhedsfaglig"- eller "system"-brugertypen. |
Brugertypen kan ikke entydigt bestemmes ud fra den medsendte sikkerhedsbillet | Denne fejl gives, hvis man ikke ud fra sikkerhedsbilletten entydigt kan afgøre, om brugeren er en "sundhedsfaglig"- eller "system"-bruger. |
Brugertypen '%s' er ikke understøttet | Fejlen gives lige nu kun hvis man forsøger at kalde GetBlurredOrganisations uden at være "system"-bruger. |
Systembruger med clientName "%s" matcher ikke det forventede navn "%s" | Det clientName som STS'en er konfigureret med, skal matche det navn som IDSAS er konfigureret med i property "idsas.allowed.client.system.name". Default value er "http://system.nspop.dk/sts". |
Sikkerhedsbilletten er udløbet |
|
Sikkerhedsbilletten er ikke gyldig endnu |
|
Sikkerhedsbilletten er ikke valid | Generisk fejl hvis årsagen ikke kunne bestemmes nærmere |
Sikkerhedsbilletten mangler |
Kald af IDSAS
Mange programmeringssprog har understøttelse for at danne kode ud fra en snitfladebeskrivelse (WSDL). Det er op til anvenderen at finde en passende udviklingsstak og passende biblioteker, der kan hjælpe med denne proces.
Udover behovet for at kunne generere klientkode ud fra en WSDL, så vil succesfuld anvendelse af IDSAS kræve, at der medsendes gyldig identifikation (gyldigt SOSI Idkort) i kaldet.
Yderligere dokumentation:
Whitelisting
For GetBlurredOrganisations operationen, er kun STS'ens system navn whitelisted.
Der er whitelistning til både Test og Produktion