Denne guide har som formål at give et overblik over hvordan behandlingsrelationsservicen (BRS) kaldes. Guiden indeholder referencer til kodeeksempler og snitfladebeskrivelser for både BRS og opfølgningsservicen.
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 beregne 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.
Slutbrugerne er i denne sammenhæng f.eks. udviklere og arkitekter hos leverandører, som ønsker at integrere til/med komponenten eller anvende den i deres systemer.
Det forudsættes, at læseren kender til Den Gode Webservice (DGWS) og den nationale serviceplatform (NSP).
Behandlingsrelationsservicen giver mulighed for automatisk at bestille opfølgninger gennem brug af notifikationsservicen, og da det forventes at denne option vil blive taget i brug 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å softwarebørsen, og det følgende præfiks er underforstået i referencerne:
https://svn.softwareborsen.dk/Behandlingsrelation/
Behandlingsrelationsservicen kører på NSP'erne under adressen:
[miljøurl]/brs-nsp/service/brs |
hvor den stiller operationen “treatmentRelation” til rådighed. Denne operation tager som input en soap-besked 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.
Eksempel på endpoint i testmiljøerne (dNSP i TEST2-miljøet):
http://test2-dnsp.ekstern-test.nspop.dk:8080/brs-nsp/service/brs
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:
| treatmentRelationRequestBody | |
| Elementer | Beskrivelse |
| OrganisationIdentifier | Organisationen inden for hvilken relationen skal findes. Feltet er struktureret og kan indeholde et sks, ydernummer eller EAN-nummer. |
| PatientCpr | Patientens cpr-nummer. |
| HealthProfessionalCpr | Behandlers cpr-nummer. |
RelationLookupTimeInterval | Tidsinterval inden for hvilket behandleren har foretaget opslaget. Kan f.eks. være validetsperioden for behandlerens ID-kort. |
TimeLimit | Udløbstidspunkt for opfølgningen efter hvilket der skal oprettes en notifikation, hvis de angivne kriterier ikke er opfyldt (se AcceptableRelations nedenfor). |
ExternalReferenceId | Ikke obligatorisk. Et id der vil blive brugt ved returnering af en eventuel notifikation. Hvis ikke feltet udfyldes, genererer BRS automatisk en værdi i svaret (se tabellen nedenfor). Formålet med feltet er at give det kaldende system mulighed for at lave egne referencer til eventuelle afklaringer af hændelsesforløb på et senere tidspunkt. |
QueryableCvr | CVR nummer der skal have adgang til en eventuel efterfølgende notifikation. Kan være det samme som den kaldende service, men det behøver det ikke være. Eventuelle notifikationer kan alene hentes af organisationer, hvor det angivne CVR nummer i dette felt matcher CVR nummeret i den anvendte digitale signatur. |
AcceptableRelations | En liste af acceptable relationer (f.eks. “A+, A, B”). Hvis den fundne kategori for en given behandlingsrelation ikke optræder i listen, bestiller BRS en opfølgning afhængigt af værdien i FollowupRelations (se næste række). |
| FollowupRelations | En liste af relationer der, i tilfælde af at ingen acceptable relationer forefindes (se ovenfor), vil give anledning til en opfølgning, f.eks. ”D, E”. Ønskes der opfølgning på alle kategorier udover dem der er angivet i AcceptableRelations sættes værdien til “ALL”. |
| AuthorisationIdentifier | Autorisationskode for den behandleren. |
| ServiceProvider | Tekststreng indeholdende navnet på serviceudbyderen (f.eks. FMK). Bruges til logformål. |
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:
”doc/brs/bilag/xsd/”
Svaret indeholder information om:
treatmentRelationResponse | |
Elementer | Beskrivelse |
SufficientRelation | Om der var tilstrækkelig relation til at foretage opslaget (”beslutningen” foretages af BRS på basis af værdien i AcceptableRelations angivet i kaldet). |
ActualRelations | Hvad de faktiske relationer er (på baggrund af kendt data fra eksterne registre). |
FollowupOrdered | Om en opfølgning er bestilt eller ej. |
UniqueReferenceId | Et unikt referenceid, der kan bruges til at koble forespørgslen sammen med en eventuel senere notifikation. Indholdet af dette felt styres af BRS. |
ExternalReferenceId | Værdien af feltet ExternalReferenceId fra forespørgslen. Hvis et sådant ikke var specificeret returneres et nyt generet id, forskelligt fra UniqueReferenceId. |
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”
Hvis der i kaldet til behandlingsrelationsservicen er angivet at der skal bestilles opfølgninger i opfølgningsservicen, vil der komme notifikationer, hvis de angivne kriterier ikke er opfyldt indenfor det i kaldet angivne tidsrum.
Disse notifikationer kan hentes på notifikationsservicen på NSP. Dokumentationen for denne kan findes i:
”doc/gos”
Notifikationer vil have en payload der opfylder xml-skemaet fundet i:
”common/src/main/resources/xsd/brs/treatmentRelationAlarm.xsd”
Dette indeholder følgende elementer:
treatmentRelationAlarm | |
Elementer | Beskrivelse |
ActualRelations | De faktiske relationer fundet for den pågældende behandler og patient. |
TreatmentRelationFollowup | Opfølgningen der gav anledning til notifikationen. |
TreatmentRelationFollowup-elementet er af typen beskrevet i
”common/src/main/resources/xsd/brs/treatmentRelationFollowup.xsd”
Denne indeholder felterne:
| treatmentRelationFollowup | |
| Elementer | Beskrivelse |
| TreatmentRelationFollowupSerialNumber | Serienummeret for den pågældende opfølgning. |
| TreatmentRelationRelayerData | Datastruktur med de nødvendige data for at udtrække gældende relationer, se tabellen nedenfor. |
TimeLimit | Tidsgrænse for en relations opståelse. En eventuel notifikation oprettes hvis der efter denne tidsgrænse ikke er opstået en gyldig relation. |
RequestSource | Det komplette kald (treatmentRelationRequestBody) der blev sendt til BRS da opfølgningen blev bestilt. |
ExternalReferenceId | Samme værdi som i det oprindelige svar fra BRS. |
UniqueId | Samme værdi som i det oprindelige svar fra BRS. |
QueryableCvr | CVR-nummer på instansen der har ret til at læse eventuelle notifikationer. |
AcceptableRelations | Relationer der skal være til stede for at opfølgningen slettes uden at give anledning til en notifikation. |
Elementet TreatmentRelationRelayerData indeholder følgende data, der er nok til at identificere de kendte relationer mellem en behandler og en patient.
TreatmentRelationRelayerData | |
Elementer | Beskrivelse |
OrganisationIdentifier | Organisationen inden for hvilken relationen skal findes. Feltet er struktureret og kan indeholde et sks, ydernummer eller EAN-nummer. |
PatientCpr | Patientents CPR-nummer. |
HealthProfessionalCpr | Den sundhedsfagliges CPR-nummer. |
RelationLookupTimeInterval | Intervallet inden for hvilket relationen skal forefindes. Vil i første omgang være trukket ud fra id-kortet i den oprindelige treatmentRelationRequest (Intervallet sættes til id-kortets gyldighedsperiode). |
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”
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
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å softwarebørsen:
https://svn.softwareborsen.dk/Behandlingsrelation/BehandlingsRelation/trunk/
Hvor følgende klasse er indgangspunktet for at kalde behandlingsrelationsservicen:
production/src/main/java/dk/nsi/behandlingsrelationservice/BRSQueries.java |
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.
Kilden til dette dokument kan findes på softwarebørsen:
https://svn.softwareborsen.dk/Behandlingsrelation/
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 |