Utgåvehistorik

1        Inledning

Detta dokument beskriver regelverket RIV Tekniska Anvisningar Tjänsteschema 2.0.

1.1      Målgrupp

Denna anvisning riktar sig till dem som ska specificera XML-scheman för tjänstekontrakt i en nationell tjänsteinteraktion. Anvisningen innehåller endast regeluppsättningen. För bakgrund, motiv, krav samt de principer som ligger till grund för framtagning av reglerna hänvisas till Översikt RIV Tekniska Anvisningar 2.1 [R2]

1.2     Syfte

Syftet med denna anvisning är att beskriva designregler och namngivningsregler för interoperabilitet samt riktlinjer för att bygga in stöd för versionshantering i tjänstescheman.

Ett uttalat syfte med tjänstescheman är att de ska kunna användas oberoende av kommunikationsstandard. Många tjänstescheman kommer dock att skapas i syfte att importeras i WSDL-filer. Reglerna för tjänstescheman är därför baserade på WS-Basic Profiles regelverk för s.k. [R4]. Målet med anvisningen är att optimera för interoperabilitet vid användning av web-service-baserade RIV TA-profiler utan att göra tjänstescheman beroende av web-services för transport och kuvertering

Exempel på tjänsteschema som följer denna anvisning finns på RIV-förvaltningens hemsida [R5] tillsamman med exempelapplikationer [R6]

1.3     Tillgänglighet

Detta dokument är publicerade under licensen Creative Commons CC-BY-SA

(http://creativecommons.org/licenses/by-sa/2.5/se/). Det betyder att du fritt får kopiera, distribuera och skapa bearbetningar av anvisningarna, under förutsättning att upphovsmannen (Sveriges Kommuner och Landsting) anges (men inte på ett sätt som antyder att de godkänt eller rekommenderar din användning av verket).

Denna profil är verifieras genom exempelapplikationer. Källkoden [R9] för dessa distribueras under öppen-källkodslicensen Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0

1.4     Referenser

2       Beskrivning av namnregler

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

1. Tjänstedomänens prefix: ${domänPrefix}, t ex riv eller riv-application
2. Tjänstedomänens namn: ${tjänsteDomän}, t ex clinicalprocess:activity:request
3. Tjänsteinteraktionens namn: ${tjänsteInteraktion}, t ex GetRequest
4. Tjänsteinteraktionsroll: ${roll} = Initiator eller Responder, motsvarande tjänsteinteraktionsroller initiativtagare och utförare
5. Tjänsteinteraktionens version:
   m.n = förkortning av ${majorVersion}.${minorVersion}
   m = förkortning av ${majorVersion}
6. Operationens namn: ${operation}, t ex MakeBooking

3       Detaljerade regler

Regel #1, designmönster för tjänstescheman

"Venetian Blind" [R7] skall användas som designmönster för tjänstescheman. Designmönstret Venetian Blind innebär följande:

• Den interna strukturen i ett meddelande byggs upp med hjälp av globalt deklarerade typer. Med ”globalt deklarerade” menas deklarationer som görs direkt under schema-elementet.
• Endast rotelementet är deklarerat som ett globalt element. I web-service-fallet innebär det att request- och response-elementen är globalt deklarerade element medan resten är typer.

Anm. I vissa fall kan även andra element än request och response behöva vara globala, t ex används element-referenser till globala element i importerade scheman för att stödja versioneringsstrategin, se nedan.

Motiv: Interoperabilitet, WS-I Basic Profile

Exempel: Tjänstekontrakten för exempelapplikationerna [R5]

Regel #2, namn på xsd-filen

Schema-filen för ett tjänstekontrat bör namnges enligt följande regel: ${tjänsteInteraktion}${roll}_${m.n}.xsd

Motiv: Att ha med versionsnummer i namnet på källkodsfiler är generellt sett något man försöker undvika då det försvårar användning av versionshanteringsverktyg (t ex Subversion, Microsoft Visual Studio). I fallet med tjänsteschema behöver man dock kunna hantera flera olika versioner samtidigt (i byggsystem mm) och för att underlätta den hanteringen ingår versionsnumret i filnamnet på tjänstekontrakt.

Anm. Detta gäller principiellt sett också de XML Schema som importeras/inkluderas av att tjänsteschema och som beskriver RIV Meddelanden men denna anvisning täcker inte in utformning av dessa XML Scheman, se [R8].

Exempel: MakeBookingResponder_1.0.xsd

Regel #3, namn på target namespace

Attributet targetNamespace på schema-elementet för en tjänsteinteraktion skall ha ett värde som definieras av följande regel: urn:${domänPrefix}:${tjänsteDomän}:${tjänsteInteraktion}${roll}:${m}

(Reglerna för namnsättning av domänprefix och tjänstedomän finns mer utförligt beskrivna i dokumentet Domännamnsättning)

Motiv:

Användningen av major-version i namnrymden är en av att följa fastslagen versioneringsstrategi [R9]. Att ha en unik namnrymd per tjänstekontrakt (tjänsteinteraktion + roll) är en förutsättning för att följa WS-I Basic Profiles [R4] regel om ”operation signature”. Det också generellt goda förutsättningar för att implementera generella bryggor och tjänsteväxlar

Exempel:

Nationell domän

urn:riv:crm:scheduling:MakeBookingResponder:1

Regel #4, namn på element

Attributet ”name” på element som deklarerar request-element i tjänsteschemat skall ha ett värde som följer följande regel: ${operation}, t ex: MakeBooking

Attributet ”name” på element som deklarerar response-element i tjänsteschemat skall ha ett värde som följer följande regel ${operation}Response, t ex: MakeBookingResponse

Motiv: För konsistent namngivning skall element för in-parametrar ha samma namn som operationen.

Exempel: ”MakeBooking” respektive “MakeBookingResponse”

Regel #5, namn på typer

Attributet ”name” på element som deklarerar request-typer i tjänsteschemat bör ha ett värde som följer följande regel: ${operation}Type

Attributet ”name” på element som deklarerar response-typer i tjänsteschemat skall ha ett värde som följer följande regel: ${operation}ResponseType

Motiv: Enhetlighet.

Exempel: ” MakeBookingType” respektive  ” MakeBookingResponseType”

Regel #6, användning av schema-attributen elementFormDefault och attributeFormDefault

Schema-attributen elementFormDefault och attributeFormDefault skall sättas till "qualified" respektive "unqualified".

Motiv: För att versioneringsstrategin skall fungera är det viktigt att alla element i instans-dokument är namespace-qualified. Detta uppnås genom att sätta schema-attributet elementFormDefault till "qualified".

Exempel: Tjänstekontrakten för exempelapplikationerna [R5]

Regel #7, användning av schema-attributet version

Schema-attributet version skall sättas till "m.n"

Motiv: Då namnrymden inte innehåller minor-version, ger detta en dokumentation som följer intentionen med attributet.

Exempel: <schema ... version="1.0>

Regel #8, användning av any-element för utökningsbarhet

För att uppnå framåtkompatibilitet skall ett xsd:any element läggas in sist i alla komplexa typer som ska kunna utökas, exempel:

Motiv: För att uppnå framåtkompatibilitet måste man "förbereda" sina XML scheman för framtida utökningsbarhet. Detta är en del av den tillämpade strategin för versionering [R9].

Exempel:

 <xs:complexType name="SomeType">

   <xs:sequence>

     <xs:element name="someElement" type="xsd:string" />

     <xs:element name="someOtherElement" type="xsd:int" />

     <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded" namespace="##other"/>

   </xs:sequence>

 </xs:complexType>

Regel #9, nya element i utökningsschema

För att skapa en ny minor-version av ett tjänsteschema, skall följande regler följas:

• De nya elementen läggs till i befintligt schema närmast före any-elementet i den komplexa typ som ska utökas. Dessa nya element har ingen typ, utan refererar (xsd:ref=”…”) element som är rotelement i en ny schema-fil (utöknings-schema)
• För att ändringen ska vara bakåtkompatibel så måste de nya elementen ha attributet minoccurs=”0”. Det leder i sin tur att any-elementet måste tas bort. Detta för att uppfylla kravet på Unique Particle Attribution i Xml Schema 1.0. Följden blir att denna komplexa typ inte kan förändras fler gånger på ett bakåtkompatibelt sätt.
• De nya elementen definieras i en ny schema-fil (utökningsschema) med ett namn som följer följande regel: ${tjänsteInteraktion}${roll}_${m.n}_ext.xsd
• Utökningsschemat ska ha en targetNamespace enligt följande regel: urn:riv:${tjänsteDomän}:${tjänsteInteraktion}${roll}:${m.n}
• Tjänsteschemat importerar (xsd:import) utöknings-schemat som ges namnrymdsalias enligt följande regel: m${n}
• Tjänsteschemats versionsattribut ändras till den nya minor-versionen.
• I nästa major-version av tjänsteschemat flyttas element-deklarationerna in från alla utökningsscheman (det finns ett för varje minor-version som tilkommit sedan förra major-versionen skapades). Dessutom läggs eventuellt borttagna any-element tillbaka, enligt regel #8.

Motiv: Detta förfarande är en konsekvens av vald strategi för versionering [R9]. Se [R2] för ytterligare bakgrund.

Se även bilaga 1 och 2 för exempel på utökningar.

Regel #10 Nationella tecken

Tjänstescheman ska undvika att använda nationella tecken i såväl elementnamn, attributnamn som vid listning av värdemämngder för uppräkningstyper. Följande exempel bör därför undvikas:

<xs:simpleType name=”Å”>

     <xs:annotation>

        <xs:documentation>…</xs:documentation>

     </xs:annotation>

     <xs:restriction base=”xs:string”>

        <xs:enumeration value=”Återställas helt” />

        <xs:enumeration value=”Återställas delvis” />

        <xs:enumeration value=”Det går inte att bedöma” />

     </xs:restriction>

</xs:simpleType>

Motiv: För att undvika interoperabilitetsproblem bör man ej använda sig av nationella tecken när man definierar typer som kommer att användas i ett tjänstekontrakt. Ofta uppstår annars fel vid kodgenerering från schemat.

Regel #11, Best-practice för felhantering

Ett tjänstekontrakt ska inte definiera några egna fel (SOAP-Fault). Istället bör följande struktur för felhantering tillämpas i svarsmeddelandet (för fråga-svar):

<xs:complexType name="MakeBookingResponseType">

    <xs:sequence>

      <xs:element name="bookingId" type="core:BookingIdType" minOccurs="0" maxOccurs="1" />

      <xs:element name="resultCode" type="tns:ResultCodeEnum" minOccurs="1" maxOccurs="1" />

      <xs:element name="resultText" type="xs:string" minOccurs="0" maxOccurs="1" />

      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>

    </xs:sequence>

</xs:complexType>

<xs:simpleType name="ResultCodeEnum">

     <xs:restriction base="xs:string">

        <xs:enumeration value="OK"/>

        <xs:enumeration value="ERROR"/>

        <xs:enumeration value="INFO"/>

     </xs:restriction>

</xs:simpleType>

Vid ett tekniskt fel levereras ett generellt undantag (SOAP-Fault). Exempel på felsituationer som rapporteras som tekniskt fel kan vara deadlock i databasen eller följdeffekter av programmeringsfel. Denna information bör loggas av tjänstekonsumenten. Informationen är inte riktad till användaren. Användaren kommer enbart att se ”tekniskt fel – inte detaljinformation. Den riktar sig till systemförvaltaren.

Vid ett logiskt fel i de uppdaterande tjänsterna levereras resultCode och resultText. Syftet med resultText är att tjänstekonsumenten av tjänsten ska kunna visa upp informationen för användaren. Läsande tjänster ska inte

resultCode kan vara:

• OK
  Transaktionen har utförts enligt uppdraget i frågemeddelandet.
• INFO
  Transaktionen har utförts enligt uppdraget i frågemeddelandet, men det finns ett meddelande som tjänstekonsumenten måste visa upp för invånaren. Exempel på detta kan vara ”kom fastande”.
• ERROR
  Transaktionen har INTE kunnat utföras enligt uppdrag i frågemeddelandet p.g.a. logiskt fel. Det finns ett meddelande som konsumenten måste visa upp (om tillämpbart, annars t.ex. skrivas i batch-log). Exempel på detta kan vara ”tiden har blivit upptagen av annan patient” (från tjänstedomän Invånarens tidbokning).

Läsande tjänster ska inte leverera information om logiska fel, d v s resultCode och resultText.

Motiv: Erfarenheter har visat att felhantering genom egen-definierade fel skapar interoperabilitetsproblem och försvårar hantering i intermediärer.              

Exempel: Se tjänsteschemat i referensapplikationen.

4         Bilaga 1: Exempel på bakåtkompatibel utökning

Följande exempel är baserat på en delmängd av tjänsteschemat för exempelapplikationerna. Det visar hur elementet subject_of_care läggs till. För att göra utökningen bakåtkompatibel så ges det nya elementet attributet minOccurs=”0”. Dessutom måste any-elementet tas bort för att uppfylla regeln Unique Particle Attribution.

Tjänsteschema, ny minorversion: GetAvailableTimeslotsResponder_1.1.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1"  xmlns:m1="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.1">

<xs:import namespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" schemaLocation="GetAvailableTimeslotsResponder_1.1_ext.xsd" />

  <xs:element name="GetAvailableTimeslots" type="tns:GetAvailableTimeslotsType" />

  <xs:complexType name="GetAvailableTimeslotsType">

    <xs:sequence>

      <xs:element name="healthcare_facility" type="core:HsaIdType" minOccurs="1" maxOccurs="1" />

      <xs:element name="bookingId" type="core:BookingIdType" minOccurs="0" maxOccurs="1" />

      <xs:element name="startDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="endDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="performer" type="core:HsaIdType" minOccurs="0" maxOccurs="unbounded" />

      <xs:element name="timeTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="timeTypeID" type="core:TimeTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="careTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="careTypeID" type="core:CareTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element ref="m1:subject_of_care" minOccurs="0"/>

      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>

    </xs:sequence>

</xs:complexType>

</xs:schema>

Utökningsschema med element som tillkommit i 1.1: GetAvailableTimeslotsResponder _1.1_ext.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.1">

  <xs:element name="subject_of_care" type="core:SubjectOfCareIdType"/>

</xs:schema>

Vid nästa major-version integreras elementen från mellanliggande utökningsscheman i huvudschemat. Elementen kan nu göras obligatoriska (minOccurs=”1”) om så önskas.

Tjänsteschema, ny majorversion GetAvailableTimeslotsResponder _2.0.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:2" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:2" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.0">

  <xs:element name="GetAvailableTimeslots" type="tns:GetAvailableTimeslotsType" />

  <xs:complexType name="GetAvailableTimeslotsType">

    <xs:sequence>

      <xs:element name="healthcare_facility" type="core:HsaIdType" minOccurs="1" maxOccurs="1" />

      <xs:element name="bookingId" type="core:BookingIdType" minOccurs="0" maxOccurs="1" />

      <xs:element name="startDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="endDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="performer" type="core:HsaIdType" minOccurs="0" maxOccurs="unbounded" />

      <xs:element name="timeTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="timeTypeID" type="core:TimeTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="careTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="careTypeID" type="core:CareTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="subject_of_care" type=”subject_of_care” minOccurs="1"/>

      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>

    </xs:sequence>

  </xs:complexType>

</xs:schema>

5         Bilaga 2: Exempel på icke-bakåtkompatibel utökning

Följande exempel är baserat på en delmängd av tjänsteschemat för exempelapplikationerna. Det visar hur elementet subject_of_care läggs till. Det nya elementet är obligatoriskt (genom attributet minOccurs=”1”), vilket gör utökningen icke-bakåtkompatibel. I gengäld kan any-elementet behållas för framtida bruk.

Tjänsteschema, ny minorversion: GetAvailableTimeslotsResponder_1.1.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1"  xmlns:m1="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.1">

<xs:import namespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" schemaLocation="GetAvailableTimeslotsResponder_1.1_ext.xsd" />

  <xs:element name="GetAvailableTimeslots" type="tns:GetAvailableTimeslotsType" />

  <xs:complexType name="GetAvailableTimeslotsType">

    <xs:sequence>

      <xs:element name="healthcare_facility" type="core:HsaIdType" minOccurs="1" maxOccurs="1" />

      <xs:element name="bookingId" type="core:BookingIdType" minOccurs="0" maxOccurs="1" />

      <xs:element name="startDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="endDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="performer" type="core:HsaIdType" minOccurs="0" maxOccurs="unbounded" />

      <xs:element name="timeTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="timeTypeID" type="core:TimeTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="careTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="careTypeID" type="core:CareTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element ref="m1:subject_of_care" minOccurs="1"/>

      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>

    </xs:sequence>

  </xs:complexType>

</xs:schema>

Utökningsschema med element som tillkommit i 1.1: GetAvailableTimeslotsResponder _1.1_ext.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:1.1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.1">

  <xs:element name="subject_of_care" type="core:SubjectOfCareIdType"/>

</xs:schema>

Vid nästa major-version integreras elementen från mellanliggande utökningsscheman i huvudschemat: GetAvailableTimeslotsResponder _2.0.xsd

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="urn:riv:crm:scheduling:1" xmlns:tns="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:2" targetNamespace="urn:riv:crm:scheduling:GetAvailableTimeslotsResponder:2" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.0">

  <xs:element name="GetAvailableTimeslots" type="tns:GetAvailableTimeslotsType" />

  <xs:complexType name="GetAvailableTimeslotsType">

    <xs:sequence>

      <xs:element name="healthcare_facility" type="core:HsaIdType" minOccurs="1" maxOccurs="1" />

      <xs:element name="bookingId" type="core:BookingIdType" minOccurs="0" maxOccurs="1" />

      <xs:element name="startDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="endDateInclusive" type="core:DT" minOccurs="1" maxOccurs="1" />

      <xs:element name="performer" type="core:HsaIdType" minOccurs="0" maxOccurs="unbounded" />

      <xs:element name="timeTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="timeTypeID" type="core:TimeTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="careTypeName" type="xs:string" maxOccurs="1" minOccurs="0" />

      <xs:element name="careTypeID" type="core:CareTypeIDType" minOccurs="0" maxOccurs="1" />

      <xs:element name="subject_of_care" type=”subject_of_care” minOccurs="1"/>

      <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>

    </xs:sequence>

  </xs:complexType>

</xs:schema>