| RIV Tekniska Anvisningar 2.1Domännamnsättning Version 1.1 2018-05-03 |
| Innehållsförteckning |
|---|
Revisionshistorik
Utgåva | Revision Datum | Beskrivning | Ändringarna gjorda av | Definitiv revision fastställd av |
1.0 | 2018-04-02 | Dokumentet skapat | Johan Eltes | |
| 1.1 | 2018-05-03 | Korrigerat exempel eftersom några var tvetydiga Lagt till innehållsförteckning | Björn Hedman | Björn Hedman |
| 1.2 | 2018-08-14 | Förtydligat att klassificering som nationell/extern eller applikationsdomän inte är hårt knutet till strukturen för namnrymdens prefix. Detta eftersom befintliga domäner ibland byter ägare utan att namnrymden ändras. | Björn Hedman | Björn Hedman |
| 1.3 | 2018-08-15 | Förtydligat att för externa domäner som har riv: som prefix så ska ska namnrymds prefixet rättas vid nästa huvudrelease | Björn Hedman | Björn Hedman |
Domännamnsättning - anvisning - Beskrivning av hur domännamnsättning sker
Domänkarta - Karta över domäner
Samtliga domäntyper skall använda samma struktur för domännamn och metadata, men har lite olika regler för namnsättning och ifyllnad av metadata. Gransknings/kvalitetssäkringsprocessen är olika för de olika domäntyperna.
...
1: Förslag till namn på domän med tillhörande metadata tas fram av projekt/intressent enligt nedanstående riktlinjer. Förslaget mailas till nationellkundservice@inera kundservice@inera.se
2: Diskussion/avstämning med Arkitektur och regelverk inklusive avstämning av beskrivning med kommunikatör
...
| Domäntyp | Beskrivning | |
|---|---|---|
| Nationell tjänstedomän | Tjänstedomänen utvecklas och/eller förvaltas av Inera. Inera A&R ansvarar för kvalité inom teknik, informatik, arkitektur och testsviter/tjänsteproducenter, samt att att domänen passar in i och har en tydlig roll i den sammantagna pottföljen av nationella tjänstekontrakt. A&Rs kvalitetssäkringsprocess följs under utvecklings- och förvaltningsfasen. | |
| Extern tjänstedomän | Annan part än Inera A&R utvecklar/förvaltar tjänstedomänen. Annan part ansvarar för kvalité inom teknik, informatik och arkitektur. Tjänstekontrakten tillämpas inte inom Ineras uppdrag. Inera A&R ansvarar inte för namnsättning utöver vad som anges nedan, men kan konsulteras om extern part önskar. Tjänstekontrakten i tjänstedomänen följer giltig RIV TA-profil (tjänstekontraktens tekniska utformning och paketering) och kan är därmed tekniskt möjliga att driftsättas och anslutningshanteras i NTJP Tjänsteplattformen om ICC.s infrastrukturkrav är uppfyllda. Tjänstekontrakten tillämpas inte inom Ineras uppdrag. Inera A&R ansvarar inte för namnsättning utöver vad som anges nedan, men kan konsulteras om extern part önskarDet innebär dock inte med automatik att Inera kommer att godkänna sådan driftsättning och anslutningshantering. | |
| Applikationsspecifik tjänstedomän | Tjänstedomänen definierar ett applikations/lösningsspecifikt API till en applikation/tjänst som ägs av Inera. Applikationsförvaltningen vill återanvända Ineras anslutningsorganisation och infrastruktur (Tjänsteplattformen), men ha kvar full kontroll över alla beslut som rör kontraktsdesign, versioner och releaser. Förvaltningen har ett eget, lokalt ansvar för tjänstekontraktens arkitektur, informatik och teknik inom ramen för det ansvar som projektet/förvaltningen har för applikationen/tjänsten i sig. Tjänstekontrakten får bara användas när den specifika applikationen/tjänsten är en av parterna i informationsutbytet. Det innebär vanligtvis att den specifika tjänsten/applikationen är tjänsteproducent ("Server") för dessa tjänstekontrakt. |
Tekniskt domännamn
Det tekniska domännamnet används i uppbyggnaden av meddelandefinitionens namnrymd. Namnrymden ger ett avtryck i den information som förs över och har därför en inverkan på kompatibilitet mellan versioner. Tjänstekontraktets huvudversion är också en del av namnrymden. Därför innebär en ändring av såväl tekniskt namn som huvudversion att kompatibiliteten (teknisk interoperabilitet) bryts. Därför kan tekniska domännamnet enbart ändras i samband med lansering av en ny huvudversion. Ineras namnsättning av tjänstedomäner är en slutprodukt av Ineras portfölj- och kvalitetsstyrningen för tjänstekontraktsutbudet. Den tekniska namnsättningen speglar i regel strukturen i den domänkarta som Inera tillämpar. Med hjälp av domänkartan kan Inera katalogisera tjänstedomäner och undvika överlapp/redundans i portföljen.
Namnsättning sker enligt följande kriterier (vid nyutveckling av domäner):
| Kriterier | Namnsättning | |
|---|---|---|
| 1 | Nationell tjänstedomän | Tekniskt domännamn tilldelas enligt gällande rutin för domännamnsättning |
| 2 | Extern tjänstedomän | Tekniskt domännamn tilldelas av ägande organisation. |
| 3 | Applikationsspecifik tjänstedomän | Tekniska domännamnets första del sätts till applikationens namn (förkortas vid behov). Resterande två delar sätts av applikationsförvaltningen. Rekommendationen är att den namnsättningen speglar applikationens egen arkitektur/namnsättning. |
| 4 | Övrigt | Kontakta Arkitektur och regelverk |
...
Tekniskt prefix är den första byggstenen i namnrymden för det innehåll som kommuniceras när tjänstekontraktet tillämpas för informationsutbyte.
...
OBSERVERA: nedanstående gäller vid nyutveckling av domäner. Domäner som bytt ägare utan att det funnits tekniska behov av förändring kan fortsatt ha tidigare prefix så det är inte nedanstående prefix som hårt styr kategoriseringen.
Vid ny huvudrelease ska dock prefix ändras och det innebär då att alla tjänstekontrakt som ingår i domänen behöver ändras och därmed få en ny huvudversion oavsett om det finns funktionella krav.
| Domäntyp | Namnsättning | |
|---|---|---|
| 1 | Nationell tjänstedomän | riv: |
| 2 | Extern tjänstedomän | riv-<ägande organisation>: |
| 3 | Applikationsspecifik tjänstedomän | riv-application: |
| 4 | Övrigt | Kontakta Bestäms efter dialog med Inera Arkitektur och regelverk |
...
Beskrivning av domänen, motsvarar dagens webtext. Beskrivning kan behöva uppdateras exempelvis till följd av nya tjänstekontrakt inom domänen. Förändring får endast ske vid majoruppdateringar och skall ske enligt rutin Hantering av webb-text /wiki/spaces/TG/pages/5182564.
Ägande organisation
Organisation som ansvarar för och äger domänen. För nationella tjänstedomäner och för applikationsspecifik tjänstedomän är ägaren Inera. För applikationsspecifika tjänstedomäner anges även vilken förvaltning inom Inera som äger applikationen vars API domänen beskriver.
...
Kategori nivå1 och nivå 2
Anges endast för Nationella tjänstedomäner.
Används för kategorisering och gruppering av domäner samt för att söka/hitta inom en domän, möjliggör en samlad bild, som annars blir fragmenterad, även om varje enskild domän är sökbar. Motsvarar det tidigare Svenskt domännamn. Viktigt i Arkitektur och regelverks arbete för att styra och förvalta tjänstekontraktsportföljen.
Kategorierna sätts enligt Arkitektur och regelverks gällande domänkartaoch sker enligt gällande rutin för domännamsättning.
Saknas domänen i gällande domänkarta får utökning/tillägg/omdefinition göras. Detta för att få den samlade bilden.
Referensmodell
Anges endast för Nationella nationella tjänstedomäner.
Referens modell
Referensmodell som har används för den tekniska namnsättning.
VIFO, IHE, HL7 FHIR m.fl på sikt
Anges endast för nationella tjänstedomäner.
Exempel
Exempel 1 –
...
Tekniskt domännamn: IHE.PCD.DEC
Tekniskt prefix: riv:
Svenskt kortnamn: Mätdata från mätutrustning
Kategori nivå 1: vård- och omsorg kärnprocess
Kategori nivå 2: hantera hälsorelaterade tillstånd
Ref modell: IHE
Ägande organisation: Inera
Domäntyp: Nationell tjänstedomän
Exempel 2 – Utomlänsfakturering
Utomlänsfakturering
Namespace: urn:riv:financial:billing:claim:1
Tekniskt domännamn: Financial:billing:claim
...
Domäntyp: Nationell Nationell tjänstedomän
Exempel
...
2 Extern domän - Läkemedelsverket
Namespace: urn:riv-lv:lv:reporting:pharmacovigilance:1
Tekniskt domännamn: cgi:healthcare:efrikort riv-lv:lv:reporting:pharmacovigilance:1
Tekniskt prefix: riv-cgilv:
Svenskt kortnamn: CGI Efrikort Läkemedelsbiverkningar
Tagg-Kategori nivå 1: N/A
Tagg-Kategori nivå 2: N/A
Tagg-Ref modell: N/A
Ägande organisation: CGI Läkemedelsverket
Domäntyp: Extern tjänstedomän
Exempel
...
3 – Applikationsspecifik domän - Stöd och behandlingsplattformen
Namespace: urn:riv-application:sob:apps:resident:1
Tekniskt domännamn: sob:apps:resident
...
Ägande organisation: Ineras förvaltning för Stöd- och behandlingsplattformen Inera
Domäntyp: Applikationsspecifik Applikationsspecifik tjänstedomän