Page History
Navitabs | ||||
---|---|---|---|---|
|
Version 1.3, 2019-07-12
Anchor | |||
---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Table of Contents |
---|
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
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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-servicennotifikationsservicen.
Anchor | ||||
---|---|---|---|---|
|
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 viden fra en række nationale registre for at bestemme den aktuelle behandlingsrelation. De konkrete registre og algoritmer, der anvendes i BRS til at bestemme den aktuelle behandlingsrelation er beskrevet i BRS - Design- og Arkitekturbeskrivelse.
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 endeligt svar til kaldet.
Anchor | ||||
---|---|---|---|---|
|
Slutbrugerne er i denne sammenhæng f.eks. udviklere og arkitekter hos leverandører, som ønsker at integrere til BRS. Se Behandlingsrelationsservice (BRS) - Leverancebeskrivelse for en forretningsmæssig beskrivelse af BRS.
Det forudsættes at læseren kender til Den Gode Webservice (DGWS) og den nationale serviceplatform (NSP).
...
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/
...
Anchor | ||||
---|---|---|---|---|
|
...
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 WSSE header samt en medcom Medcom header som specificeret i Den Gode Webservice (DGWS) version 1.0.1. IDKortet SOSI 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
Anchor | ||||
---|---|---|---|---|
|
...
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:
...
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.
...
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Notifikationsservicen udstilles på NSP'erne under adressen Wiki Markup
*\[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._
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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 IDKortetSOSI idkortet, der optræder i soap SOAP headeren.
Denne operation tager en soap SOAP besked som input, indeholdende en header og en body. Headeren indeholder en wsse WSSE header samt en medcom Medcom header, som specificeret i Den Gode Webservice (DGWS) version 1.0.1. IDKortet SOSI idkortet i headeren skal være på niveau 3.
...
Hvor følgende klasse er indgangspunktet for at kalde behandlingsrelationsservicen production/src/main/java/dk/nsi/behandlingsrelationservice/BRSQueries.java
...
Version | Dato | Ændring | Ansvarlig |
---|---|---|---|
0.1 | 2011-06-15 | Initielt Dokument | Trifork |
0.2 | 2011-07-27 | Ændringer jf. skift til generel notifikationsservice indført. | Trifork |
0.3 | 2011-08-10 | Opsplitning jf. opsplitning af BRS og GOS | Trifork |
0.9 | 2013-03-14 | Grundig bearbejdning i samarbejde mellem sundhed.dk og NSI. | NSI/CHE |
1.0 | 2013-10-23 | Rettet SVN links og xsd link der pegede forkert | Trifork |
1.1 | 2017-03-08 | Tilrettet BRS2 | Trifork |
1.2 | 2017-03-14 | Konkretiseret afsnit om notifikationer | Trifork |
1.3 | 2018-07-12 | Opdateret link til repository og mulighed for registrering med sor | KvalitetsIT |
1.4 | 2020-11-12 | Review af dokumentation | KvalitetsIT |