Version 1.3, 2019-07-12

Indholdsfortegnelse

Indholdsfortegnelse
1 Formål
1.1 Baggrund
1.2 Målgruppe og forudsætninger
2 Snitfladebeskrivelse
2.1 Behandlingsrelationsservice
2.1.1 Endpoint
2.1.2 treatmentRelationRequestBody
2.1.3 treatmentRelationResponse
2.1.4 BRS notifikationer via Notifikationsservicen
2.2 Notifikationsservice
2.2.1 Endpoint
2.2.2 Betingelser for kald
2.2.3 notificationQueryRequestBody
2.2.4 notificationQueryResponse
2.2.5 TreatmentRelationAlarm
2.2.6 TreatmentRelationFollowup
2.2.7 TreatmentRelationRelayerData
2.3 Format for tidsstempler
2.4 Fejlkoder
3 Eksempler på at kalde services
3.1 Java frameworks
3.1.1 Eksempelkode i Java
3.2 .NET frameworks
4 Ændringslog

Formål

Denne guide har som formål at give et overblik over, hvordan behandlingsrelationsservicen (BRS) kaldes, samt hvorledes der hentes notifikationer fra opfølgninger ed notifikationsservicen.
Guiden indeholder referencer til kodeeksempler og snitfladebeskrivelser for kald til behandlingsrelationsservicen og notifikations-servicen.

Baggrund

Behandlingsrelationsservicen (BRS) er en service, der returnerer den bedst kendte behandlingsrelation imellem en borger og en sundhedsfaglig person på et givet tidspunkt.
I sundhedssektoren findes der ikke et register over behandlingsrelationer, og BRS gør derfor brug af afledt viden fra en række nationale registre for at bestemme den aktuelle behandlingsrelation.
Da den gængse registreringspraksis tillader opdateringer af registrene i et relativt stort tidsrum efter en handling, kan gentagne kald til BRS med samme input give forskelligt resultat over tid, idet datagrundlaget med stor sikkerhed vil ændre sig i dagene og ugerne efter en sundhedsfaglig hændelse, f.eks. en lægekonsultation eller et indlæggelsesforløb på et sygehus.
Man kan i kaldet til BRS vælge at lade servicen håndtere denne kompleksitet, idet man gennem en række parametre kan konfigurere BRS-håndteringen og styre hvordan – og hvornår – der skal leveres et svar til kaldet.

Målgruppe og forudsætninger

Slutbrugerne er i denne sammenhæng f.eks. udviklere og arkitekter hos leverandører, som ønsker at integrere til BRS.
Det forudsættes at læseren kender til Den Gode Webservice (DGWS) og den nationale serviceplatform (NSP).

Snitfladebeskrivelse

Behandlingsrelationsservicen giver mulighed for at bestille opfølgninger gennem brug af notifikationsservicen. Da det forventes at denne option vil blive brugt af de fleste anvendere, er begge snitflader dokumenteret nedenfor.
Bemærk at der refereres til teknisk dokumentation af snitfladeelementerne i afsnittene nedenfor med referencer sat i anførselstegn. Disse referencer peger på BRS-projektet på nspop, og det følgende præfiks er underforstået i referencerne:
https://svn.nspop.dk/svn/components/brs/

Behandlingsrelationsservice

Endpoint

Behandlingsrelationsservicen kan tilgås i de decentrale NSP-miljøer (dNSP) under adressen
*\[miljøurl\]/brs-nsp/service/brs*
\\
hvor den stiller operationen "treatmentRelation" til rådighed. Denne operation tager en soap besked som input, indeholdende en header og en body. Headeren indeholder en wsse header samt en medcom header som specificeret i Den Gode Webservice (DGWS) version 1.0.1. IDKortet i headeren skal være på niveau 3 og udstedt af SOSI-STS. WSDL findes ved at tilføje "?wsdl"-postfix til adressen.
Eksempel på endpoint i testmiljøerne (dNSP i TEST2-miljøet):
http://test2-dnsp.ekstern-test.nspop.dk:8080/brs-nsp/service/brs

treatmentRelationRequestBody

Body er defineret som et element af typen treatmentRelationRequestBody, der er en complexType indeholdende en række felter, er specificeret i
"common/src/main/resources/xsd/"
Frem for at læse disse foreslås det at studere eksemplet på en korrekt forespørgsel i
"doc/brs/bilag/requests-and-responses/"
En korrekt forespørgsel skal indeholde informationer om følgende:

treatmentRelationResponse

Operationen "treatmentRelation" returnerer et treatmentRelationResponse, der opfylder DGWS. Det vil sige, at det har en wsse og en medcom header. Selve svaret er defineret som et treatmentRelationResponseBody som defineret i
"common/src/main/resources/xsd/"
Svaret indeholder information om:

Et eksempel på et svar fra servicen kan findes i
"bilag/requests-and-responses/"
Den komplette wsdl for servicen kan findes i
"common/src/main/resources/wsdl"

BRS notifikationer via Notifikationsservicen

Hvis der i kaldet til behandlingsrelationsservicen er angivet at der skal bestilles opfølgninger i opfølgningsservicen, vil der komme alarm-notifikationer, hvis de angivne kriterier ikke er opfyldt indenfor det i kaldet angivne tidsrum.
Disse notifikationer kan hentes med notifikationsservicen i det decentrale NSP-miljø.
Hvis der derimod indenfor det angivne tidsrum opnås tilstrækkelig evidens, så de angivne kriterier er opfyldt, bliver der ikke genereret notifikationer.

Notifikationsservice

Endpoint

Notifikationsservicen udstilles på NSP'erne under adressen 
*\[miljøurl\]gos/service/notification*
\\
hvor den sætter operationen "notificationQuery" til rådighed.
Eksempel på endpoint i testmiljøerne (dNSP i TEST2-miljøet):
http://test2-dnsp.ekstern-test.nspop.dk:8080/gos/service/notification
_Bemærk: NSP miljøernes loadbalancer router trafikken fra ovennævnte endpoint til brs-nsp/service/notification, idet dette er adressen i BRS2._

Betingelser for kald

Man kan hente notifikationer der er "udstedt" til ens eget CVR nummer – altså notifikationer, hvis QueryableCvr matcher CVR nummeret i headeren ved kaldet til Notifikationsservicen. Bemærk at CVR nummeret ikke indgår som en eksplicit parameter, da det er indeholdt i IDKortet, der optræder i soap headeren.
Denne operation tager en soap besked som input, indeholdende en header og en body. Headeren indeholder en wsse header samt en medcom header, som specificeret i Den Gode Webservice (DGWS) version 1.0.1. IDKortet i headeren skal være på niveau 3.

notificationQueryRequestBody

Body er defineret som et element af typen notificationQueryRequestBody, der er en complexType indeholdende en række felter, der er specificeret i
"common/src/main/resources/xsd/notification/"
Frem for at læse denne foreslås det at studere eksemplet på en korrekt forespørgsel i
"doc/bilag/requests-and-responses/"
En korrekt forespørgsel skal indeholde informationer om følgende:

notificationQueryResponse

Operationen "notificationQuery" returnerer et notificationQueryResponse der opfylder DGWS. Det vil bl.a. sige, at det har en wsse og en medcom header. Selve svaret er defineret som et notificationQueryResponseBody som defineret i
"common/src/main/resources/xsd/notification/"
Svaret indeholder de første 100 notifikationer med serienummer højere end eller lig det der er angivet i forespørgslen. Notifikationerne returneres i sorteret rækkefølge. Hver notifikation indeholder følgende informationer:

Et eksempel på et svar fra servicen kan findes i
"doc/bilag/requests-and-responses/"
Den komplette wsdl for servicen kan findes i
"common/src/main/resources/wsdl"
Notifikationers "payload" er af typen TreatmentRelationAlarm. Skema for dette findes her:
"common/src/main/resources/xsd/brs/treatmentRelationAlarm.xsd"
Dette indeholder følgende elementer:

TreatmentRelationAlarm

TreatmentRelationFollowup

TreatmentRelationFollowup-elementet er af typen beskrevet i
"common/src/main/resources/xsd/brs/treatmentRelationFollowup.xsd"
Denne indeholder felterne:

TreatmentRelationRelayerData

Elementet TreatmentRelationRelayerData indeholder følgende data, der er nok til at identificere de kendte relationer mellem en behandler og en patient.

Format for tidsstempler

Bemærk at formatet på alle tidsstempler (f.eks. TimeLimit og RelationLookupTimeInterval) er som følger: YYYY-MM-DD'T'HH:MM:SS'+'forskydning fra GMT', f.eks. "2013-01-31T22:59:40+02:00"

Fejlkoder

Nedenfor ses en liste af typiske fejl der kan forekomme når en service kaldes. Fejl der returneres indeholder en fejlkode samt en fejltekst med yderligere detaljer. Teksten er ikke medtaget i tabellen nedenfor da den kan variere afhængig af hvad der gav anledning til fejlen.

Eksempler på at kalde services

Java frameworks

JAVA SEAL er et open source bibliotek, der kan håndtere SOSI IDKort, DGWS og integration til SOSI-STS. Biblioteket er dokumenteret på digitaliser.dk:
http://digitaliser.dk/group/374971

Eksempelkode i Java

Der er udviklet testkode, der gør brug af JAVA SEAL biblioteket, sammen med JAXWS webservicestakken til at kalde de to services. Eksemplet kan bruges til at teste de forskellige service-håndtag fra ydersiden. Man kan med fordel tage udgangspunkt i eksemplet, når der implementeres en javabaseret webserviceklient, der gør brug af BRS og opfølgningsservicen.
Test-koden kan hentes fra projektet på nspop:

https://svn.nspop.dk/svn/components/brs

Hvor følgende klasse er indgangspunktet for at kalde behandlingsrelationsservicen

production/src/main/java/dk/nsi/behandlingsrelationservice/BRSQueries.java

.NET frameworks

Seal.NET er et open source framework, der kan håndtere SOSI IDKort, DGWS og integration til SOSI-STS. Seal.NET er dokumenteret på digitaliser.dk:
http://digitaliser.dk/group/375117
Der er pt. ikke skrevet eksempelkode på at kalde de to services fra et .NET projekt, men der er WSDL'er til rådighed, som man kan anvende i Visual Studio's webservice wizard, kombineret med Seal.NET.

Ændringslog