Open	RIV Tekniska Anvisningar Basic Profile 2.1   Version 3.0 ARK_0002 2024-09-18

Innehållsförteckning

1. Inledning

Detta dokument beskriver regelverket för RIV-profilen Basic Profile 2.1.

För ytterligare beskrivning av RIV-profiler se anvisningen RIV Tekniska Anvisningar SOAP Webservices

Open

Anvisningen i sitt sammanhang

1.1 Målgrupp

Denna anvisning riktar sig till dem som ska specificera WSDL för en nationell tjänsteinteraktion i enlighet den RIV-profil som benämns Basic Profile. Anvisningen innehåller endast regeluppsättningen som definierar profilen.

1.2 Syfte

Syftet med denna anvisning är att beskriva hur man realiserar utbytet av information mellan två parter på ett interoperabelt sätt baserat på WS-I Basic Profile v1.1 för de typer av tjänsteinteraktioner som anges i T-boken.

För bakgrund, motiv, krav samt de principer som ligger till grund för utvecklingen av profilen hänvisas till RIV Tekniska Anvisningar SOAP Webservices.

1.3 Tillgänglighet

Detta dokument är publicerat under licensen Creative Commons CC-BY-SA (Sammanfattning - Erkännande-DelaLika 2.5 - Creative Commons ).

Det betyder att du fritt får kopiera, distribuera och skapa bearbetningar av anvisningarna under förutsättning att upphovsmannen Sveriges Kommuner och Regioner anges, men inte på ett sätt som antyder att de godkänt eller rekommenderar din användning av verket.

2. Beskrivning av namnregler

Denna profils namn är ”RIV Tekniska Anvisningar – Basic Profile 2.1” och refereras ${profil}

Denna profils kortnamn är ”rivtabp21” och refereras ${profilKortnamn}

Namngivningsregler i detta dokument är formulerade enligt följande uppställning:

1. Tjänstedomänens namn: ${tjänsteDomän}, t ex clinicalprocess:activity:request

2. Tjänsteinteraktionens namn: ${tjänsteInteraktion}, t ex GetRequestStatus

3. Tjänsteinteraktionsroll: ${roll} = Initiator eller Responder, motsvarande tjänsteinteraktionsroller initiativtagare och utförare

4. Tjänsteinteraktionens version:
   m.n = förkortning av ${majorVersion}.${minorVersion}
   m = förkortning av ${majorVersion}

5. Operationens namn: ${operation}, t ex GetRequestStatus

3. Följsamhet mot externa regelverk

Här definieras de externa regelverk (t.ex. profiler) som utgör regelbas för denna profil. Det är en målsättning att denna profil ska kunna läsas uppifrån och ner utan detaljerad kunskap om externa regelverk. För regler som inte lyfts fram i denna profil (av förbiseende eller för att de inte bedömts viktiga) hänvisas till de externa regelverk som redovisas här.

Regel #1, Följsamhet mot WS-I-profiler

Utforming av WSDL skall följa WS-I Basic Profile v1.1 (WS-I Basic Profile - Version 1.1) och WS-I Simple SOAP Binding Profile v1.0 (Simple WS-I SOAP Binding Profile - Version 1.0).

Motiv: Interoperabilitet

3.1 Förtydligad hantering av SOAP Fault

Tekniska fel återrapporteras med ett svarsmeddelande utformat som ett SOAP Fault i enlighet med WS-I.

SOAP-standarden, vilken WS-I bygger på, definierar fyra generella felkoder:

1. VersionMismatch

2. MustUnderstand

3. Client

4. Server

Ur en tjänsteproducents perspektiv är Client och Server mest intressanta. Faultcode=’soap:Client’ betyder att det är fel på tjänstebegärans innehåll eller dess kontext (exempelvis klientcertifikat eller konsumentens åtkomstbehörighet), och att omsändning inte ska ske utan felkorrigerande åtgärd på konsumentsidan. Faultcode=’soap:Server’ betyder att behandlingen gått fel, men det var inget fel på begäran i sig och omsändning kan ske.

Det rekommenderas att hålla sig till de generella felkoderna, men om man för ett tjänstekontrakt absolut behöver definiera egna felkoder med finare granularitet, skall dessa definieras i en separat namnrymd. Konsumentens förväntade agerande baserat på dessa felkoder måste finnas tydligt beskrivna i tjänstekontraktsbeskrivningen.

Exempel:

Information i SOAP Faults bör loggas av tjänstekonsumenten. Informationen är inte riktad till användaren utan till systemförvaltaren. Detaljinformationen från ett SOAP Fault är normalt sett inte avsett att visas för användaren utan riktar sig till systemförvaltaren via loggning.

Felbeskrivning i fälten faultstring och detail ska innehålla tillräcklig information för att driva felsökningen framåt. Om det till exempel finns identifieringsbegrepp eller loggid som kan underlätta felsökning skall dessa inkluderas.

Fältet faultactor kan användas i enighet med SOAP-standarden, men dess utformning och användning definieras ej av RIV-TA utöver SOAP-standardens riktlinjer.

Exempel:

3.2 Förtydligad hantering av http headrar

Headrar ska alltid tolkas skiftlägesokänsligt i enlighet med specifikationen för http. Se https://www.ietf.org/rfc/rfc2616.html#section-4.2 för detaljer

4. Detaljerade regler

Regel #2, Namngivning av WSDL-fil

WSDL-filen bör namnges enligt följande regel: ${tjänsteInteraktion}Interaction_${m.n}_${profilKortnamn}.wsdl

Motiv: Minska risk för missförstånd rörande vilken version som används

Exempel: MakeBookingInteraction_1.0_RIVTABP21.wsdl

Regel #3, namn på <definitions>-element

Name-attributet för elementet wsdl:definitions bör ges värde enligt följande regel: ${tjänsteInteraktion}Interaction

Motiv: Enhetlighet

Exempel: MakeBookingInteraction

Regel #4, namn på target namespace

Namn på target namespace skall vara urn:riv:${tjänsteDomän}:${tjänsteInteraktion}:m:${profilKortnamn}

Motiv: Suffixet rivtabp21 skall anges för att markera att wsdl'en är designad för att följa RIV Tekniska anvisningar - Basic Profile v2.1. Versionsnumret saknar praktisk betydelse i WSDL:ens namnrymd, men är avgörande för versionering i tjänstescheman. Eftersom samma versionsnummer ska användas genomgående inom en tjänsteinteraktion blir konsekvensen att targetnamespace är angeläget att styra även för WSDL.

Exempel: urn:crm:scheduling:MakeBooking:1:rivtabp21

Regel #5 – Dokumentation av tjänsteinteraktion

Första elementet under wsdl:definitions bör dokumenteras enligt följande uppställning:

Motiv: Underlätta användning och förvaltning.

Exempel:

Regel #7 – Document/Literal

För konsistent namngivning och ökad förståelse skall följande regler följas:

• "SOAP binding style" skall sättas till "document"

• "SOAP body use" skall sättas till "literal"

• Varje wsdl:message skall ha en och endast en wsdl:part för soap-bodyn, som skall vara namnsatt till "parameters"

• Varje message-element som inte är av schema-grundtyp skall referera till ett XML Schema element ur ett importerat (xsd:import) tjänsteschema ur samma tjänsteinteraktion som denna WSDL.

• XML Schema-elementet för "input message" skall vara namnsatt till operationens namn. Se RIV Tekniska Anvisningar - Tjänsteschema för definition av element som refereras från wsdl:message

• XML Schema elementet för "output message" skall vara namnsatt till operationens namn + suffix "Response". RIV Tekniska Anvisningar - Tjänsteschema

Motiv: Verktygsinteroperabilitet och följsamhet mot WS-I Basic Profile 1.1.

Regel #8: Logisk adressering

Elementet {urn:riv:itintegration:registry:1}LogicalAddress skall användas för att i soap-header ange logisk adressat.

• Tjänstekonsument skall ange logisk adress för adresserad tjänsteproducent. För utformning av logiska adresser hänvisas till RIV-TA Översikt

• WSDL:en skall importera (xs:import) följande schema för namnrymd "urn:riv:itintegration:registry:1" som bör ges namnrymdsalias "riv": itintegration_registry_1.n.xsd, t.ex. itintegration_registry_1.0.xsd

• Det första wsdl:Part-elementet i varje wsdl:Message som definierar ett request-meddelande skall ha namnet LogicalAddress och värdet "riv:LogicalAddress" för attributet "element".

• Varje LogicalAddress-part enligt ovan skall bindas till soap:header under wsdl:binding / wsdl:operation / wsdl:input.

• Varje wsdl:operation ska föregås av en wsdl:documentation som ger utvecklare av tjänstekonsumenter och tjänsteproducenter vägledning om eventuella begränsningar avseende LogicalAddress. Den kan t.ex. vara att HSA-id måste vara på nivån Enhet, eller att det måste vara en administrativ huvudman med ansvar för medborgares vårdval.

Motiv: T-bokens referensarkitektur definierar en adresseringsmodell där tjänsteproducenter antingen adresseras på verksamhetsnivå eller systemnivå. Den logiska adressen uttrycks till exempel med hjälp av verksamhetens eller systemets HSA-id alternativt annat tillämpbart kodverk i enlighet med respektive domäns tjänstekontraktsbeskrivning

För ytterligare detaljer kring adresseringsmodellen se RIV-TA Översikt

Regel #9, namn på <portType>-element

Name-attributet för elementet wsdl:portType bör ha värde enligt följande regel: ${tjänsteInteraktion}${roll}Interface.

Motiv: Enhetlighet och koppling till referensarkitekturens terminologi

Exempel: MakeBookingResponderInterface

Regel #10, namn på <binding>-element

Name-attributet för elementet wsdl:binding bör ha värde enligt följande regel: ${tjänsteInteraktion}${roll}Binding.

Motiv: Enhetlighet och koppling till referensarkitekturens terminologi

Exempel: MakeBookingResponderBinding

Regel #11, namn på <service>-element

Name-attributet för elementet wsdl:service bör ha värde enligt följande regel: ${tjänsteInteraktion}${roll}Service.

Motiv: Enhetlighet och koppling till referensarkitekturens terminologi

Exempel: MakeBookingResponderService

Regel #12, namn på <port>-element

Name-attributet för elementet wsdl:port bör ha värde enligt följande regel: ${tjänsteInteraktion}${roll}Port.

Motiv: Enhetlighet och koppling till referensarkitekturens terminologi

Exempel: MakeBookingResponderPort

Regel #13, namn på <message>-element

Name-attributet för elementet wsdl:message skall ha värde enligt följande regler:

• In-meddelande skall namnges ${operation}Request

• Ut-meddelande skall namnges ${operation}Response

Motiv: Konsekvent namngivning

Exempel: ” MakeBookingRequest” respektive ” MakeBookingResponse”

Regel #14, namn på <operation>-element

Name-attributet för elementet wsdl:operation skall ha värde enligt följande regel:

${operation}

Motiv: Konsekvent namngivning

Exempel: MakeBooking

Regel #15, värde för soapAction-attribut

soapAction-attributet för elementet soap:operation skall ha värde enligt följande regel: urn:riv:${tjänsteDomän}:${tjänsteInteraktion}${roll}:m:${operation}

Motiv: När man följer WS-I Basic Profile har soapAction-attributet på operatonsbindningen för soap-binding ingen praktisk verkan. Det är istället viktigt att Qualified Name för varje operations meddelande ger en unik signatur. Se WS-I Basic profile 1.1, Appendix C - operation signatur och R1127. För interoperabilitet med Microsoft .Net-baserade tjänsteproducenter (WCF) måste dock soapAction sättas till ett för ändpunkten unikt värde.

Denna regel anger att soapAction skall ha samma innehåll som "operation signature", vilket är tjänsteschemats namnrymd och elementnamnet på operationens "input message" (d.v.s. request-elementets namnrymd och namn).

Exempel: urn:riv:crm:scheduling:MakeBookingResponder:1:MakeBooking

Regel #16, targetNamespace i schema:import

Vid import av scheman i WSDL-filen skall targetNamespace anges för xs:schema-elementet. Värdet på targetNamespace-attributet skall vara samma som WSDL:ens targetNamespace.

Motiv: WS-I Basic Profile kräver ej den här ändringen men vissa ramverk har historiskt krävt att targetNamespace specificeras så för ökad interoperabilitet kräver vi det i Basic Profile. Av den här anledningen skall man alltid ange targetNamespace för att få ökad interoperabilitet. WS-I tillåter inte att targetNamespace är samma som det importerade schemats namnrymd.

Exempel:

Regel #17, Förhållandet mellan porttype och operationer

Endast en operation per porttype och en porttype per tjänsteschema. Det betyder att en WSDL-fil antingen har en eller två porttypes: WSDL-filen för en fråga-svar-interaktioner och en informationsspridningsinteraktioner har en porttype medan uppdrag-resultat-interaktioner har två porttypes.

Motiv: Möjliggöra versionshanteringstrategin som beskrivs i RIVTA Översikt

5. Tjänstekomponenter

Regel #18, WSDL-first

Tjänstekonsumenter och tjänsteproducenter skapas genom s.k. “WSDL-first”. Det betyder att WSDL-filen skapas först och sedan nyttjas som underlag för kodgenerering av tjänstekomponenternas implementation.

Motiv: Säkerställa att tjänstekomponenter följer interaktionens tjänstekontrakt.

Regel #19, Uppbyggnad av URL för tjänsteproducent Utgått

Regel #29, Stöd för parallella huvudversioner

En tjänsteproducent som behöver erbjuda stöd för parallella huvudversion behöver ha en metod för att kontrollera vilken huvudversion som ett anrop avser. Detta kan göras genom att kontrollera SOAP-headern för namespace för att fastställa vilket tjänstekontrakt och vilken version som används i en interaktion. Alternativ metod kan vara att separera versioner med url:ens utformning.

Motiv: Möjliggöra realisering av den versionsstrategi som stödjs av tjänstekontrakt som tagits fram enligt denna profil samt att parallellt erbjuda stöd för flera tjänster baserade på olika huvudversioner av samma tjänstekontrakt

Exempel:

Separation via namespace: urn:riv:crm:scheduling:CancelBooking:1:rivtabp21

Separation via URL: https://tidbok.landsting.sjunet.org/MakeBooking/1/rivtabp21

Regel #20, Meta-data i run-time

Det är INTE obligatoriskt för en tjänsteproducent att i runtime (t.ex. med “?wsdl” som suffix på soap-adressen) kunna återskapa den WSDL som låg till grund för utvecklingen av tjänsteproducenten.

Motiv: Alla plattformar förmår inte återskapa metadata i runtime för tjänster som följer denna profil (t.ex. vissa .Net-versioner och versioner av BizTalk server). Det är inget problem eftersom tjänstekonsumenten ska utvecklas “wsdl-first” baserat på WSDL-fil – inte på runtime-metadata från tjänsten själv.

Regel #21, Övervakningstjänst Utgått

Regel #22, Förnyade anropsförsök vid tillfälligt otillgänglig tjänsteproducent

Denna regel rör tjänstekonsumenter som genomför anrop i någon form av bakgrundsprocess med krav på förnyade anropsförsök vid tillfälligt otillgängliga tjänsteproducenter:

1. Förnyade anropsförsök får inte resultera i högre anropsfrekvens än vad SLA för tjänsten tillåter under normal drift. För automatiserad omsändningsstrategi rekommenderas ökande omsändningsintervall för att inte belasta nät och producentsystem i onödan.

2. Om tjänstekonsumenten anropar olika logiska adressater via en virtuell tjänst kan olika anrop nå olika bakomliggande tjänsteproducenter. Under sådana omständigheter ska tjänstekonsumentens logik vara utformad så att omsändning till en otillgänglig adressat inte blockerar väntande anrop med andra adressater eftersom dessa kan komma att dirigeras till en tillgänglig tjänsteproducent.

3. SLA-regelverket för en tjänstekonsument ska vara uttryckt på ett sätt som gör det möjligt att förutsäga vilken anropsfrekvens som är möjlig för en tjänstekonsument, så att tjänstekonsumenten kan säkerställa att punkt 1 ovan efterlevs.

4. Bedömning av om förnyat anropsförsök ska göras beror på om felet anses vara av tillfällig natur till exempel vid en time out, felkod vp009 eller ett annat tekniskt fel. vid andra fel som till exempel vp007 så kräver felet åtgärd innan det är ide med omsändning.

5. Respektive tjänstekontraktsbeskrivning kan ytterligare definiera regler kring omsändning.

Motiv: Att undvika DoS-liknande anropsmönster i samband med otillgänglig tjänsteproducent.

Exempel: En policy för förnyade anropsförsök kan t.ex. upprätthållas genom att tjänstekonsumenten använder en intern meddelande-kö som betas av, av en eller flera parallella processer eller trådar. Om varje sådan parallell hantering läser från början av kön, anropar tjänsteproducenten i den takt som tillåts enligt SLA och vid otillgänglig tjänsteproducent skriver tillbaka meddelandet sist på kön. Innan meddelandet som resulterade i felaktigt anrop åter hamnar först har alla väntande meddelanden hanterats. På så viss vis sker förnyade anropsförsök kontinuerligt men utan att anrop till tillgängliga tjänsteproducenter blockeras. Beroende på applikationsspecifika krav kan det eventuellt vara idé att istället hantera misslyckade anrop i en separat kö och låta dem cirkulera där tills berörda tjänsteproducenter blivit tillgängliga och anropen kunnat genomföras.

Regel #23: Mottagande av ursprunglig tjänstekonsuments identitet i http header

En tjänsteproducent kan utnyttja http-headern ”x-rivta-original-serviceconsumer-hsaid” för att få reda på identiteten av den ursprungliga tjänstekonsumenten.

Motiv: Detta ger en möjlighet för tjänsteproducenter att identifiera den ursprungliga tjänstekonsumenten.

Exempel: En tjänsteproducent sitter bakom en regional tjänsteplattform. Tjänstekonsumenten anropar den nationella tjänsteplattformen som i sin tur anropar den regionala. Det blir nu den nationella tjänsteplattformen som fångar upp identiteten från tjänstekonsumentens klientcertifikat och sätter det i http-headern. Den regionala tjänsteplattformen för bara vidare inkommande http-header till sitt utgående anrop till tjänsteproducenten.

Regel #24: Information om uppdragsgivande part

En tjänstekonsument (som identifieras av ”x-rivta-original-serviceconsumer-hsaid”) ska, om de utför ett anrop på uppdrag av annan part, informera om detta. Detta görs genom att tjänstekonsumenten bifogar http-headern “x-rivta-acting-on-behalf-of-hsaid”. Informationsinnehållet i denna header ska vara ett HSA-id som representerar den uppdragsgivande verksamheten.

Tjänsteproducenter kan använda informationen till att begränsa åtkomst till tjänsten eller anpassa returnerat informationsomfång.

Motiv: Detta ger en möjlighet för tjänsteproducenter att identifiera uppdragsgivande verksamhet bakom en tjänstekonsuments anrop om man vill ha en mer fingranulär åtkomstkontroll än att bara basera sig på ursprunglig tjänstekonsument.

Exempel: Ett anrop som sker från ett agentsystem för en viss verksamhets räkning indikerar denna uppdragsgivande verksamhets HSA-id i http-headern. Tjänsteproducenten kan då ta beslut om att samverka med vissa utvalda verksamheter som nyttjar samma agents system.

Regel #28: Hantering av nekad åtkomst

Nekade åtkomstbeslut ska resultera i ett av tre olika svar enligt nedan beroende på var i anropskedjan felet uppstår:

• Om första tjänsteplattform nekar teknisk åtkomst till tjänsteplattformen själv ska det resultera i att felkod HTTP 403 Forbidden returneras.

  • Exempelvis att den anropande tjänstekonsumenten använder ett ogiltigt certifikat eller på andra grunder nekas anslutning

• En tjänsteplattforms virtualiseringsplattformskomponent som själv tar beslut om nekad åtkomst ska returnera detta fel som ett SOAP Fault med kod VP007 i felmeddelandet.

  • Exempelvis om det saknas en giltig anropsbehörighet i TAK

• Beslut om nekad åtkomst som tas av en faktisk tjänsteproducent ska resultera i att felkod HTTP 403 Forbidden returneras.

  • Exempelvis om en tjänsteproducent baserar åtkomst på riv-ta headrar enligt reglerna #23 och #24

• En tjänsteplattforms virtualiseringsplattformskomponent som tar emot en HTTP 403 Forbidden ska omvandla detta fel till ett SOAP Fault med kod VP016 i felmeddelandet.

Motiv: Detta underlättar för tjänstekonsumenter att hantera felsituationer baserade på saknad åtkomstbehörighet och även urskilja denna felorsak från andra.

Exempel: Ett anrop för informationsförsörjning vid kvalitetsregisterrapportering via NKRR-systemet kan få ökad förståelse vid felsituationer när faktiska tjänsteproducenter vitlistat anrop från specifika registerplattformar.

Regel #6 – Kryptering och Autentisering

HTTPS med ömsesidig autentisering (mutual TLS) skall användas för autentisering av tjänsteproducent och tjänstekonsument samt för kryptering av trafiken mellan parter som tillhör olika organisationer.

Se även RIV Tekniska Anvisningar - Kryptering för ytterligare information.

Motiv: Insynsskydd, oavvislighet med avseende på parternas identitet, samt möjlighet för tjänsteproducent att verifiera teknisk anropsbehörighet.

6. Status för anrop till aggregerande tjänster

Nedan beskrivs en utökning av basprofilen som ger möjlighet att rapportera teknisk information om bearbetningen i en aggregerande tjänst. Informationen skickas tillbaka till anropande tjänstekonsument i SOAP-svaret som en SOAP-header med namnet "ProcessingStatus".

SOAP-headern innehåller en lista med en rad per anropat källsystem och ger per källsystem information huruvida anropet gick bra, om svaret kom från cache eller om det hämtades från källsystemet, hur gammal den cachade informationen är. För detaljer se regel #25. 

SOAP headern beskrivs inte i de tjänsteinteraktioner (WSDL-filer) som en aggregerande tjänst följer, detta för att kunna använda samma tjänsteinteraktioner som de underliggande tjänsteproducenterna använder.

Nedan ett exempel där en tjänstekonsument anropar en aggregerande tjänst som via engagemangsindex får reda på att det finns information att hämta i två olika källsystem. Den aggregerande tjänsten anropar de två källsystemen (parallellt) och sätter samman ett aggregerat svar till tjänstekonsumenten där SOAP-headern ”ProcessingStatus” ingår. Detta illustreras av följande bild:

Om något av de anropade källsystemen inte svarar inom en föreskriven tid eller returnerar ett fel så kommer SOAP-headern ProcessingStatus innehålla information om att svaret inte är komplett utan bara partiellt samt information om vilket fel som uppstod.

Regel #25: Aggregerande tjänster skall returnera status om bearbetning av ett anrop

Implementationer av aggregerande tjänster skall returnera en SOAP-header med namnet "ProcessingStatus". Headern skall rapportera teknisk information om bearbetningen i tjänsten. Headern skall följa elementet ProcessingStatus i XML-schemat interoperability_headers_1.0.xsd.

Motiv: Ge tjänstekonsumenter möjligheten att verifiera att de fått ett komplett svar från den aggregerande tjänsten och om så inte är fallet kunna rapportera tillbaka till användaren att svaret bara är partiellt.

Exempel: Se ovan.

Regel #26: Tjänstekonsumenter av en aggregerande tjänster kan ta del av status om bearbetning av ett anrop

Tjänstekonsumenter av en aggregerande tjänster kan ta del av status om bearbetning av ett anrop till en aggregerande tjänst genom att ta del av innehållet i SOAP-headern med namnet "ProcessingStatus" i svaret från den aggregerande tjänsten. Headern rapporterar teknisk information om bearbetningen i tjänsten. Headern följer elementet ProcessingStatus i XML-schemat interoperability_headers_1.0.xsd.

Motiv: Ge tjänstekonsumenter möjligheten att verifiera att de fått ett komplett svar från den aggregerande tjänsten och om så inte är fallet kunna rapportera tillbaka till användaren att svaret bara är partiellt.

Exempel: Se ovan.

Regel #27: Aggregerande tjänster skall återanvända befintlig tjänsteinteraktion (WSDL-fil)

Aggregerande tjänster skall återanvända befintlig tjänsteinteraktion (WSDL-fil), dvs. använda samma tjänsteinteraktioner som de underliggande tjänsteproducenterna använder. Det medför att SOAP-headern "ProcessingStatus" inte beskrivs explicit i de enskilda WSDL-filerna utan istället definieras i denna anvisning.

Motiv: SOAP-headern beskrivs inte i de tjänsteinteraktioner (WSDL-filer) som en aggregerande tjänst följer, detta för att enkelt kunna återanvända samma tjänsteinteraktioner som de underliggande tjänsteproducenterna använder. Minskar kostnader och risk för fel i samband med vidareutveckling och förvaltning av tjänsteinteraktioner.