| RIV Tekniska Anvisningar 2.1 Domänschema Version 2.1.23 ARK_0006 20152018-12-17
05-08 |
| Innehållsförteckning |
|---|
Utgåvehistorik
...
Utgåva | Revision Datum | Beskrivning | Ändringarna gjorda av | Definitiv revision fastställd av | ||
PA1 | 2011-06-27 | Dokumentet skapat |
| |||
A | 2011-10-19 | Fastställd revision | Arkitekturledningens tekniska expertgrupp, Center för eHälsa i samverkan | |||
PB1 | 2011-12-14 | Uppdaterat dokumentet i och med byte av projektplats från Osor till Google code. Enbart ändringar under rubriken Referenser. | hans.thunberg@callistaenterprise.se
| |||
B | 2012-01-03 | Fastställd revision |
| Arkitekturledningens tekniska expertgrupp, Center för eHälsa i samverkan | ||
C | 2013-06-19 | Ny revision efter CeHis nya processer | Arkitektur och regelverk, Center för eHälsa i samverkan | Arkitektur och regelverk, Center för eHälsa i samverkan | ||
2.1.1 | 2014-08-20 | Förtydligat regel #6 och flyttat XML-exempel till bilagor. | Mattias Nordvall, Inera | |||
2.1.1 | 2014-09-26 | Lagt över i Inera mall och publiserat. | Lennart Eriksson, Inera |
| ||
2.1.2 | 2015-12-17 | Uppdaterat länkar i referenstabell | Mattias Nordvall, Inera |
|
1 Inledning
...
| 2.1. |
...
...
| 3 | 2018-05-08 | Lagt till att även domänprefix kan ha olika värden, var förut hårt satt till "riv:" Förtydligat namnsättningsregler och struktur för domän resp interaktionsnivå Ändrat regel #4 från bör till skall | Björn Hedman, Inera |
1 Inledning
Detta dokument beskriver regelverket RIV Tekniska Anvisningar Domänschema 2.1.
1.1 Målgrupp
Denna anvisning riktar sig till dem som ska specificera XML-scheman för tjänstekontrakt i en nationell tjänstedomän. 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 [R2].
...
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).
1.4 Referenser
Ref | Dokument | Beskrivning och ev. webbadress | Ansvarig |
[R1] | Beskrivning av ”Venetian Blind” | Dokumentet beskriver det designmönster som tillämpas för XML Schema design i denna anvisning. Webblänk till hemsidan: | Okänd. |
[R2] | Översikt RIV Tekniska Anvisningar | Bakgrund, motiv, krav samt de principer som ligger till grund för utvecklingen av denna anvisning. | Arkitekturledningens tekniska expertgrupp, SKL |
[R3] | W3C-rapport om utökningsbara XML-scheman | Beskriver problemställningar och strategier för design av meddelanden som ger bra stöd för versionshantering. Versioneringsstrategin som beskrivs i denna översikt och som tillämpas i RIV Teknisk Anvisning Tjänsteschema är baserad på strategi nr 2 i denna rapport. | W3C |
[R4] | WS-I Basic Profile | ”Defines the WS-I Basic Profile 1.1, consisting of a set of non-proprietary Web services specifications, along with clarifications, refinements, interpretations and amplifications of those specifications which promote interoperability” | The Web Services Interoperability Organization och ISO |
2 Meddelanderegler
...
Attributet targetNamespace på schema-elementet skall ha ett värde som definieras av följande regel: urn:${domänPrefix}:${tjänsteDomän}:${majorVersion}
Namngivningsregler för namespace är formulerade enligt följande uppställning:
- Tjänstedomänens prefix: ${domänPrefix}, t ex riv eller riv-application
- Tjänstedomänens namn: ${tjänsteDomän}, t ex clinicalprocess:
...
- activity:request
- Domänschemats version: ${majorVersion}, tex 1
Reglerna för namnsättning av domän finns mer utförligt beskrivna i dokumentet för domännamnsättning
Motiv:
Domänprefixet ska avspegla vilken organisation som ansvarar för support och utveckling av respektive domän.
Användningen av major-version i namnrymden är en av att följa fastslagen versioneringsstrategi [R3]. 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:itintegration:monitoring:1
Applikationsdomän
urn:riv-application:sob:apps:resident:1
Extern domän
urn:riv-lv.lv.reporting.pharmacovigilance
Regel #4, användning av schema-attributet version
Schema-attributet version bör skall sättas till "m.n"
Motiv: Då namnrymden inte innehåller minor-version, ger detta en dokumentation som följer intentionen med attributet.
...
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.
3 Bilaga 1: Exempel på bakåtkompatibel utökning
...
<xs:element name="lastName" type="xs:string"/>
</xs:schema>
Vid nästa major-version görs följande förändringar:
...