Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Path for WSDL uden security headers

  • [server-URL]/brs-nsp/service/[path]
  • [server-URL]/brs-nsp/service/[path]

Hvor path er en af følgende:

  • brs?wsdlbrs20220314
  • 20250301/brs?wsdl
  • notification?wsdl
  • notification20210921?wsdl
  • notification20220314?wsdl

...

  • secure-wsdl/brs
  • secure-wsdl/brs2022031420250301/brs
  • secure-wsdl/notification
  • secure-wsdl/notification20210921
  • secure-wsdl/notification20220314

...

Anchor
_Toc477258564
_Toc477258564
Behandlingsrelationsservice

Versioner

Snitfladen til behandlingsrelationsservicen findes i to versioner, hver med sin egen version af treatmentRelation. Der er den oprindlige udgave, og den nye udgave fra 2025. I den nye udgave er ændringer, at man får en liste af evidenskilder med tilbage i svaret.

Anchor
_Toc477258565
_Toc477258565
Endpoint

Behandlingsrelationsservicen kan tilgås i de decentrale NSP-miljøer (dNSP) under adressenadresserne

  • *\[miljøurl\]/brs-nsp/service/brs*
  • *\[miljøurl\]/brs-nsp/service/20250301/brs*

hvor den stiller operationen "treatmentRelation" 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. SOSI idkortet i headeren skal være på niveau 3 og udstedt af SOSI-STS.

...

treatmentRelationRequestBody

Elementer

Beskrivelse

Felt krævet

OrganisationIdentifier

Organisationen inden for hvilken relationen skal findes. Feltet er struktureret og kan indeholde et sks, ydernummer, sor kode eller EAN-nummer.

Ja

PatientCpr

Patientens cpr-nummer.

Ja

HealthProfessionalCpr

Behandlers cpr-nummer.

Ja

RelationLookupTimeInterval

Tidsinterval inden for hvilket behandleren har foretaget opslaget. Kan f.eks. være validetsperioden for behandlerens ID-kort.

Ja

TimeLimit

Udløbstidspunkt for opfølgningen efter hvilket der skal oprettes en notifikation, hvis de angivne kriterier ikke er opfyldt (se AcceptableRelations nedenfor).

Ja

ExternalReferenceId

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.

Ja

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.

Ja

MiinimumAcceptableRelation

Et enkelt minimum acceptabelt forhold. Ud fra dette opbygges en liste af acceptable relationer (f.eks. "A+, A, B") over alle relationer ovenfor og inklusive den mindst acceptable relation. Er alle relationer acceptable, angives værdien "ANY".
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).

Ja

Followup

Skal der laves en opfølgning, hvis MinimumAcceptableRelation ikke blev nået.

Ja

AuthorisationIdentifier

Autorisationskode for den behandleren.

Ja

ServiceProvider

Tekststreng indeholdende navnet på serviceudbyderen (f.eks. FMK). Bruges til logformål.

Ja

IncludeAllRelations

Hvis denne værdi sættes til "true" vil treatmentRelationResponse inkludere alle evidens kilder. Værdien er sat til at være default "false" og den er ikke påkrævet.

Nej

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.

...

Hvis der derimod indenfor det angivne tidsrum opnås tilstrækkelig evidens, så de angivne kriterier er opfyldt, bliver der ikke genereret notifikationer.

Eksempel

Code Block
languagexml
firstline1
titleBRS Request
linenumberstrue
collapsetrue
<treatmentRelationRequestBody xmlns="https://nspop.dk/nsp/behandlingsrelation/2022/03/14/brs">
    <OrganisationIdentifier>
        <DoctorOrganisationIdentifier>561010</DoctorOrganisationIdentifier>
    </OrganisationIdentifier>
    <PatientCpr>3112910017</PatientCpr>
    <HealthProfessionalCpr>1007707419</HealthProfessionalCpr>
    <RelationLookupTimeInterval>
        <start>2023-01-01T16:16:31+01:00</start>
        <end>2024-01-01T16:16:31+01:00</end>
    </RelationLookupTimeInterval>
    <MinimumAcceptableRelation>E</MinimumAcceptableRelation>
    <TimeLimit>2016-01-01T16:16:31+01:00</TimeLimit>
    <QueryableCvr>46837428</QueryableCvr>
    <Followup>false</Followup>
    <AuthorisationIdentifier />
    <ServiceProvider>
        <Name>myServiceProviderName</Name>
        <Version>snapshot</Version>
        <Vendor>arosii</Vendor>
    </ServiceProvider>
	<IncludeAllRelations>true</IncludeAllRelations>
</treatmentRelationRequestBody>

Følgende er et eksempel på et request til BRS uden IncludeAllRelations:

Code Block
languagexml
titleBRS Request
collapsetrue
<treatmentRelationRequestBody xmlns="http://nsi.dk/fmki20110601/brs">
  <OrganisationIdentifier>
    <DoctorOrganisationIdentifier>132435</DoctorOrganisationIdentifier>
  </OrganisationIdentifier>
  <PatientCpr>0101601951</PatientCpr>
  <HealthProfessionalCpr>0101601803</HealthProfessionalCpr>
  <RelationLookupTimeInterval>
    <start>2013-09-30T00:00:00+02:00</start>
    <end>2013-10-25T23:59:00+02:00</end>
  </RelationLookupTimeInterval>
  <TimeLimit>2013-09-30T11:04:37+02:00</TimeLimit>
  <QueryableCvr>31908574</QueryableCvr>
  <AcceptableRelations>
    <Relation>A</Relation>
    <Relation>B</Relation>
  </AcceptableRelations>
  <FollowupRelations>
    <All>All</All>
  </FollowupRelations>
  <AuthorisationIdentifier>DM712</AuthorisationIdentifier>
  <ServiceProvider>
    <Name>SJ</Name>
    <Version>0.1</Version>
    <Vendor>Sundhed.dk</Vendor>
  </ServiceProvider>
</treatmentRelationRequestBody>

Svar fra BRS

Svar fra BRS

Operationen "treatmentRelation" 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.  Betydningen af felterne er opsummeret i tabellen nedenfor:

treatmentRelationResponse

Elementer

Beskrivelse

Felt krævet

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).

Nej

ActualRelation

Hvad de faktiske relationer er (på baggrund af kendt data fra eksterne registre).

Ja

RelationBySources

En liste over relationer efter kilder. Hver post er et par af datakilden, hvor relationen stammer fra, og den aktuelle relation fundet fra denne datakilde.

Ja

FollowupOrdered

Om en opfølgning er bestilt eller ej.

Nej

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.

Ja

ExternalReferenceId

Værdien af feltet ExternalReferenceId fra forespørgslen. Hvis et sådant ikke var specificeret returneres et nyt generet id, forskelligt fra UniqueReferenceId.

Ja

Eksempel

Følgende er et eksempel eksempler på et response responses fra BRS:

Code Block
firstlinelanguage1xml
titleResponse fra BRS
linenumberstrue
(oprindelig snitflade)
collapsetrue
<ns6:treatmentRelationResponseBody xmlns:ns6="http://nsi.dk/fmki20110601/brs" xmlns="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#" xmlns:ns3="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns7="http://rep.oio.dk/cpr.dk/xml/schemas/core/2005/03/18/" xmlns:ns8ns7="http://rep.oio.dk/cvrcpr.dk/xml/schemas/2005/03/22/">
	<ns6:SufficientRelation>true</ns6:SufficientRelation>
	<ns6:ActualRelations>
		<ns6:Relation>D</ns6:Relation>
	</ns6:ActualRelations>
	<ns6:RelationsBySources>
		<ns6:RelationBySource>
			<ns6:Source>LPR</ns6:Source>
			<ns6:Relation>E</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>SIKREDE</ns6:Source>
			<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>REFHOST</ns6:Source>
			<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>HENVISNING_SOR</ns6:Source>
			<ns6:Relation>E</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>SSR</ns6:Source>
	/schemas/core/2005/03/18/" xmlns:ns8="http://rep.oio.dk/cvr.dk/xml/schemas/2005/03/22/">
	<ns6:SufficientRelation>true</ns6:SufficientRelation>
	<ns6:ActualRelations>
		<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
	</ns6:RelationsBySources>ActualRelations>
	<ns6:FollowupOrdered>false</ns6:FollowupOrdered>
	<ns6:UniqueReferenceId>bd80bca9UniqueReferenceId>744bb53a-5f303c67-4e4c4a91-b30fa3c1-0ebceb16ec24<eb91b9bc9e3e</ns6:UniqueReferenceId>
	<ns6:ExternalReferenceId>040865cdExternalReferenceId>b1a35898-6a2ef699-40b94a76-a574a274-e9a88e25d5d7<c005ee7d763a</ns6:ExternalReferenceId>
</ns6:treatmentRelationResponseBody>
Code Block
languagexml
firstline1
titleResponse fra BRS (2025-udgave)
linenumberstruetitleResponse fra BRS uden RelationBySource
collapsetrue
<ns6:treatmentRelationResponseBody xmlns:ns6="http://nsi.dk/fmki20110601/brs" xmlns="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#" xmlns:ns3="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns7="http://rep.oio.dk/cpr.dk/xml/schemas/core/2005/03/18/" xmlns:ns8="http://rep.oio.dk/cvr.dk/xml/schemas/2005/03/18/" xmlns:ns8="http://rep.oio.dk/cvr.dk/xml/schemas/2005/03/22/">
	<ns6:SufficientRelation>true</ns6:SufficientRelation>
	<ns6:ActualRelations>
/22/">
	<ns6:SufficientRelation>true</ns6:SufficientRelation>
	<ns6:ActualRelations>
		<ns6:Relation>D</ns6:Relation>
	</ns6:ActualRelations>
	<ns6:RelationsBySources>
		<ns6:RelationBySource>
			<ns6:Source>LPR</ns6:Source>
			<ns6:Relation>E</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>SIKREDE</ns6:Source>
			<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>REFHOST</ns6:Source>
			<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>HENVISNING_SOR</ns6:Source>
			<ns6:Relation>E</ns6:Relation>
		</ns6:RelationBySource>
		<ns6:RelationBySource>
			<ns6:Source>SSR</ns6:Source>
			<ns6:Relation>D</ns6:Relation>
		</ns6:RelationBySource>
	</ns6:ActualRelations>RelationsBySources>
	<ns6:FollowupOrdered>false</ns6:FollowupOrdered>
	<ns6:UniqueReferenceId>744bb53aUniqueReferenceId>bd80bca9-3c675f30-4a914e4c-a3c1b30f-eb91b9bc9e3e<0ebceb16ec24</ns6:UniqueReferenceId>
	<ns6:ExternalReferenceId>b1a35898ExternalReferenceId>040865cd-f6996a2e-4a7640b9-a274a574-c005ee7d763a<e9a88e25d5d7</ns6:ExternalReferenceId>
</ns6:treatmentRelationResponseBody>

...