HSA-schema tjänsteträdet. Version

Transkript

1 HSA-schema tjänsteträdet Version 4.5

2 Innehåll Revisionshistorik Inledning Tabellen Regional information Övrig information Information från överliggande objekt Språk Rekommendationer kring tecken i objektsnamn Rekommendationer kring tecken i attributvärden Attribut i HSA Tjänsteträd Geografisk information Geografisk indelning Internetuppgifter SITHS Certifikatsinformation Enhetsinformation Objektinformation Teknisk information Syntax Förklaring till Format och Multiplicitet Referenser anisationsnummer Sid 2/21

3 Revisionshistorik I revisionshistoriken nedan redogörs för de ändringar som skett i denna version av HSAschemat. För information om tidigare versioners ändringar se aktuell version av detta dokument. Revisionshistoriken redogör även för ändringar av teknisk information som specificeras i motsvarande exceldokument [1]. Version Datum Status Fastställd i HSA Förvaltningsgrupp med följande ändringar: Införande av två nya grenar i HSA Tjänsteträd, se motsvarande excelark för information om attribut i dessa grenar: - Certifier (dc=certifier), för hantering av HOSP-kontroll för personer som inte finns i HSA (berör intygstjänster) - HSA Domain (dc=hsa Domain), för hantering av domäner och domänområden för administrativa uppdrag Borttag av attributet fakturaadress I HOSP-grenen (dc=hosp) har attributet beskrivning, description, lyfts fram eftersom det anger tidpunkt då HOSP senast uppdaterades med uppgifter ifrån Socialstyrelsen Fastställd i HSA Förvaltningsgrupp med följande ändringar: Förtydligande av syntax för attributet HSA-id Förtydligande av innehållsbekrivning för attributet slutdatum Fastställd i HSA förvaltningsgrupp med följande ändringar: Tillägg av attributet HOSP-id, hospidentitynumber, i dc=hosp Förtydligad teknisk beskrivning för attributet förskrivarkod, personalprescriptioncode, i dc=koder Se motsvarande excelark för information om dessa båda ändringar i dc=hosp 4.5 Fastställd av HSA Förvaltningsgrupp med följande ändringar: Justerad innehållsbeskrivning och teknisk kommentar för attributen HSA användarlösenord, ansvarig person, certifikatsmottagare, enhetsnamn och epostadress Justerad innehållsbeskrivning för attributet HSAadministratörens kommentar Ändrad svensk attributbenämning, innehållsbeskrivning och teknisk kommentar för atttributet medlem i administratörsgrupp anisationsnummer Sid 3/21

4 Version Datum Status Förtydligand teknisk kommentar för attributen certifikatsnummer, giltigt fr.o.m., giltigt t.o.m. samt HCC Borttag av attributen länskod och länsnamn i HSA Tjänsteträd Ändrat svenskt attributbenämning och innehållsbeskrivning för attributet domaincomponent, dc nodnamn Justerad teknisk beskrivning för attributet beskrivning 1 Inledning Detta dokument är en fristående bilaga till RIV Informationsspecifikation HSA Struktur och innehåll [2] och beskriver objekt och attribut i HSA Tjänsteträd. Alla objekt och attribut som presenteras i HSA Tjänsteträd måste följa de anvisningar som beskrivs i detta dokument. 1.1 Tabellen Kolumnerna i tabellerna på nästföljande sidor har följande innebörd: Attribut Beskrivning Format Mult Kodverk/ Beslutsregel/ Teknisk beskrivning Det svenska namnet på attributen följt av attributets LDAP-namn. I de fall synonymer används för LDAP-namnet står även dessa med. Innehållsmässig beskrivning av attributet. Beskriver hur innehållet ska vara formaterat enligt RIV. För ytterligare information om format hänvisas till en beskrivning sist i dokumentet. I några fall anges format även direkt i fältet. Anger multiplicitet för attributet, dvs. antal möjliga förekomster av attributet. Attribut i HSA kan antingen vara envärdes- eller flervärdesattribut. attribut innebär att attributet endast kan ha ett värde för en viss instans av ett objekt. Flervärdesattribut kan däremot ha flera värden. Mer information om RIV-angivelse av detta finns i slutet av detta dokument. Anger namn på kodverket/värdemängden som innehåller tillåtna värden för attributet. Teknisk beskrivning av och eventuella kommentarer till attributen. anisationsnummer Sid 4/21

5 imal teckenlängd i HSA för attributet. Detta är i de flesta fall ingen katalogteknisk begränsning utan en överenskommelse inom HSA för att underlätta användning av attribut inom andra områden. Ett kryss i denna kolumn anger att attributet används för objektklassen anization. Om Obl är angivet istället för ett kryss innebär detta att attributet är obligatoriskt för objektklassen, dvs. attributet ska ha innehåll. Ett kryss i denna kolumn anger att attributet används för objektklassen anizational. Om Obl är angivet istället för ett kryss innebär detta att attributet är obligatoriskt för objektklassen, dvs. attributet ska ha innehåll. Ett kryss i denna kolumn anger att attributet används för objektklassen anizational (Funktion). Om Obl är angivet istället för ett kryss innebär detta att attributet är obligatoriskt för objektklassen, dvs. attributet ska ha innehåll. DomainComponent,, består av två nivåer. Den första nivån, Services, innehåller ingen annan information än själva namnet. Den andra nivån av DomainComponent kallas Nod X. Ett kryss i kolumnen anger att attributet används för den andra nivån av objektklassen DomainComponent. Om Obl är angivet istället för ett kryss innebär detta att attributet är obligatoriskt för objektklassen, dvs. attributet ska ha innehåll. 1.2 Regional information Det är tillåtet att lagra information i den egna delen av HSA som inte finns specificerad i detta dokument. Detta kan till exempel vara intressant för regiongemensamma ändamål. Vad man då bör vara uppmärksam på är att om man använder generella attribut och objekt ur LDAP/X.500- standarden löper man risken att dessa i ett senare skede blir formellt definierade i HSA och man blir då tvungen att anpassa sig. Dessutom finns vissa standardattribut som används på icke standardmässigt sätt i HSA. Det rekommenderas att man istället använder egna attribut med egna namn, lämpligen inledda med något eget prefix, och egna OID:er. Inom HSA har varje organisation möjlighet att få en egen OID-serie för dessa attribut. Dessa beskrivs i detta dokuments tillhörande excelark [1]. Det kan även vara lämpligt att dölja dessa för andra än dem som kan förstå dem. 1.3 Övrig information Information från överliggande objekt Generellt försöker man undvika dubbellagring. Därför har i de flesta fall ett personobjekt till exempel ingen adressinformation. I de fall man saknar information av en viss typ på ett objekt bör man alltid söka informationen på närmast överliggande objekt Språk Alla attribut ska fyllas med svensk text. Om så önskas kan den svenska texten i tillämpliga fall kompletteras med text på andra språk. anisationsnummer Sid 5/21

6 1.3.3 Rekommendationer kring tecken i objektsnamn Den teknik som används i HSA ger vissa begränsningar i vilka tecken som kan användas i namn på objekt. Textsträngar som lagras i HSA kan rent tekniskt innehålla vilka tecken som helst men för att praktisk användning av allehanda tecken ska vara möjlig måste även samtliga klienter som använder HSA vara förberedda för att hantera alla tecken. Alla klienter på marknaden är inte förberedda och inom HSA finns inte total kontroll över vilka klienter som används. Istället finns dessa rekommendationer. Namn på personobjekt begränsas naturligt av vilka tecken som Skatteverket tillåter i folkbokföringen (ISO/IEC ). Vad gäller namn på enheter och funktioner, som oftast är manuellt registrerade i katalogen/katalogerna, är det istället viktigt att rekommenderade tecken kan kommuniceras till administratörer. Tecken som kan orsaka tekniska problem och som ska undvikas i objektnamn är: Tecken * Stjärna Benämning + Plus \ Bakåt snedstreck, Komma ; Semikolon Citattecken < Mindre än > Större än ( Vänster parentes ) Höger parentes Mellanslag först och/eller sist i texten Null Inget tecken (Unicode 0000) Rekommendationen gäller i första hand attributen enhetsnamn, ou (organizationalname), organisationsnamn, o (organizationalname) och objektnamn, cn (commonname) men också alla andra attribut som kan uppträda som RDN (RelativeDistinguishedName) Rekommendationer kring tecken i attributvärden Det är tillåtet att använda radbrytningstecken i fritextattribut vid behov. anisationsnummer Sid 6/21

7 2 Attribut i HSA Tjänsteträd 2.1 Geografisk information Geografisk indelning land (c, countryname) Landets tvåställiga bokstavsbeteckning enligt ISO 3166 om annat än Sverige. KTOV Beslutsregel/Teknisk kommentar Anges med 2 bokstäver enligt ISO X X X Associationer En Geografisk indelning indelar noll till flera Funktioner Beslutsregel En Geografisk indelning indelar noll till flera Enheter 2.2 Internetuppgifter Beslutsregel/Teknisk beskrivning e-postadress (mail, rfc822mailbox) Funktionens e-postadress, oftast en funktionsbrevlåda. KOM (e-post) enligt regel Attributet fylls endast i om e-postadressen ska finnas i certifikatet för att t.ex. använda krypterad och/eller signerad e-post till 255 X X X anisationsnummer Sid 7/21

8 Beslutsregel/Teknisk beskrivning funktionen. Associationer En Internetuppgift är kontaktuppgift till noll till flera Enheter Beslutsregel En Internetuppgift är kontaktuppgift till noll till flera Funktioner 2.3 SITHS Certifikatsinformation certifikatsmottagare (hsacertificaterecipient) HSA-id för den som är utpekad mottagare av certifikat för funktionen. II Flervärdes (0..*) Beslutsregel/Teknisk beskrivning Observera att SITHS i dagsläget inte använder detta attribut i HSA. Certifikatsmottagare anges på SITHS beställningsblankett för funktionscertifikat. 128 X certifikatsnummer (serialnumber) SITHS-certifikatets serienummer. II Flervärdes (0..*) Informationen registreras av SITHS vid skapande av HCC och tas bort vid spärr av HCC. 64 X giltigt fr.o.m. (validnotbefore) giltigt t.o.m. (validnotafter) Det datum som SITHScertifikatet är giltigt från och med. Det datum som SITHScertifikatet är giltigt till och med. Datum (TP) Datum (TP) Flervärdes (0..*) Flervärdes (0..*) Informationen registreras av SITHS vid skapande av HCC och tas bort vid spärr av HCC. Informationen registreras av SITHS vid skapande av HCC och tas bort vid spärr av HCC. X X anisationsnummer Sid 8/21

9 HCC (usercertificate) Giltiga SITHS-certifikat. TXT (certifikat ) Flervärdes (0..*) Beslutsregel/Teknisk beskrivning SITHS-certifikat av typen HCC Funktion. Informationen registreras av SITHS vid skapande av HCC och tas bort vid spärr av HCC. X Associationer En Certifikat innehas av noll eller en Funktion Beslutsregel 2.4 Enhetsinformation enhetsnamn (ou, organizationalname) Kan vara enhetens namn eller namnet på en gruppering av funktioner. Exempel: "e-recept". TXT enligt regel (1..1) Beslutsregel/Teknisk beskrivning Rekommendationen är att skriva in hela enhetsnamnet istället för en förkortning. Enbart ett enhetsnamn får anges i HSA. Endast engelska alfabetet (a-z), siffror (0-9) samt bindestreck (-) och understreck (_) får användas. 64 Obl X organisationsnamn (o, organizationname) I tjänsteträdet anges organisationsnamn utan å, ä, ö, och mellanslag. Exempel: o= Region_Skane. TXT enligt regel (1..1) 64 Obl X anisationsnummer Sid 9/21

10 organisationsnummer (orgno) anisationsnummer enligt SCB/Bolagsverket. Exempel: II (XXXXXX- XXXX) enligt regel Beslutsregel/Teknisk beskrivning Sekelsiffran 16 ska inte vara med. 12 Obl X X Associationer En Enhet består av noll eller flera Enheter Beslutsregel En Enhet hör till noll eller en Geografisk indelning En Enhet består av noll eller flera Funktioner 2.5 Objektinformation ansvarig person (hsaresponsibleperson) HSA-id för den som ansvarar för funktionen. II Flervärdes (0..*) Beslutsregel/Teknisk beskrivning Om den ansvariga personen inte finns i organisationen och inte har HSA-id kan namn- och kontaktuppgifter skrivas in i HSA-administratörens kommentar. 128 X beskrivning (description) Kort beskrivning/förklaring av speciellt intresse. TXT enligt regel Ska endast innehålla information som får visas för objektet. På o- nivå ska organisationens vedertagna namn skrivas, t ex Region Östergötland. För funktioner kan systemtyp anges 1024 X X X X anisationsnummer Sid 10/21

11 Beslutsregel/Teknisk beskrivning och vad den används till. HSA-id (hsaidentity) Obligatorisk, unik identifierare för personer, enheter, funktioner och organisationer i HSA. II (HSAid) (1..1) Se beskrivning av HSA-id i dokumentet RIV Informationsspecifikation HSA Struktur och innehåll. Syntaxen är uppbyggd på följande sätt: SE<Katalogägarens organisationsnummer med 10 tecken>-<valfria bokstäver (A-Z och a-z) och siffror (0-9)>. Observera att tecknen å, ä, ö inte är tillåtna. 31 Obl Obl Obl HSA-administratörens kommentar (hsaadmincomment) Administrativ kommentar, t.ex. namn- och kontaktinformation till ansvarig person som inte finns i HSA. TXT Attributet är endast synligt för HSA-administratörer inom det egna behörighetsområdet X X X objektnamn (cn, commonname) Funktionens namn. TXT enligt regel (1..1) URI/DNS-namn för tjänsten registreras alltid i attributets objektnamn om SITHS-certifikat ska skapas, ex cn=dsedix.ds.sll.se. 64 Obl Endast domännamn som ägs av organisationen de befinner sig under (o=[organisationen]) får anisationsnummer Sid 11/21

12 Beslutsregel/Teknisk beskrivning läggas upp i objektnamn. Om andra domännamn läggs in skall skriftlig fullmakt finnas mellan organisationen som äger domännamnet och organisationen där objektnamnet finns. slutdatum (enddate) Eventuellt slutdatum då en enhet eller funktion upphör sin verksamhet. Om inget slutdatum anges tolkas det som "tillsvidare". DT (Datum) Tidsangivelse I GMT (Greenwich Mean Time). Exempel: Z. X X X startdatum (startdate) Startdatum då en enhet eller funktion startar sin verksamhet eller då en person börjar sin anställning. DT (Datum) Tidsangivelse I GMT (Greenwich Mean Time). Exempel: Z. X X X Associationer En Funktion hör till noll eller en geografisk indelning Beslutsregel En Funktion är del av en och endast en Enhet En Funktion innehar noll eller flera Certifikat anisationsnummer Sid 12/21

13 2.6 Teknisk information Beslutsregel/Teknisk beskrivning antal närmast underliggande objekt (numsubordinates) antal underliggande objekt (numallsubordinates) Antal närmast underliggande objekt. Totalt antal underliggande objekt. KV KV (1..1) (1..1) Attributet används av SITHS statisitk och loggar. Attributet kan inte fyllas i manuellt utan innehållet skapas med automatik. Värdet är alltid 0 på person-, funktions- och uppdragsobjekt. Attributet används av SITHS statisitk och loggar. Attributet ska inte fyllas i manuellt utan innehållet skapas med automatik. Värdet är alltid 0 på person-, funktions- och uppdragsobjekt. X X X X X X X X X X nodnamn (dc, domaincomponent) Namn på nod i HSA Tjänsteträd (DomainComponent, ). Exempel: Nod 1, Uppdragsmallar, Koder. TXT (1..1) Obl anisationsnummer Sid 13/21

14 Beslutsregel/Teknisk beskrivning HSA användarlösenord (userpassword) Lösenord för systemanvändare av HSA. 128 (Octet) X HSA-id-prefix (hsaidprefix) Anger vilket HSA-idprefix som ska användas när objekt skapas. VÄ (SEXXXXX XXXXX-) X HSA-id-räknare (hsaidcounter) Räknare som används för att skapa unika HSA-id:n. 0..* 40 X medlem i administratörsgrupp (uniquemember) Pekare till person som ingår i administratörsgrupp. Personen får de administratörsrättighet er som administratörsgruppen är tilldelad, gäller oftast den enhet som administratörsgruppen är placerad under med II Flervärdes (1..*) Exempel: "cn=maria Larsson,ou=Systemavdelningen,o=L andstinget Sörmland,l=Sörmlands län,c=se". anisationsnummer Sid 14/21

15 Beslutsregel/Teknisk beskrivning underliggande objekt. senaste förändringstidpunkt (modifytimestamp) Information om tidpunkt för senaste förändring. TP (Datum) Operativt attribut som skapas med automatik av databasen vid förändring av information på objektet i något attribut. Tidsangivelse i GMT (Greenwich Mean Time). Exempel: " Z". X X X X senast ändrad av (modifiersname) DN för objekt (användare) som senast förändrade objektet. Kan vara en administratör eller ett system. II (DN) X X X X skapad av (creatorsname) DN för objekt (användare) som skapat objektet. Kan vara en administratör eller ett system. II (DN) X X X X anisationsnummer Sid 15/21

16 Beslutsregel/Teknisk beskrivning skapandetidpunkt (createtimestamp) Information om tidpunkt för skapandet av objektet. TP (Datum) Operativt attribut som skapas med automatik av databasen. Tidsangivelse i GMT (Greenwich Mean Time). Exempel: " Z". X X X X anisationsnummer Sid 16/21

17 3 Syntax Datum HSAid Enligt RFC4517. Det vill säga minst YYYYMMDDhhZ. Där Z står för tidszonen Zulu, d v s UTC. SE[Katalogägarens organisationsnummer med 10 tecken]-[valfria bokstäver (A-Z och a-z) och siffror (0-9)]. Observera att tecknen å, ä, ö inte är tillåtna. De katalogägare som redan börjat använda organisationsnummer med sekelsiffra (d.v.s. 12 tecken) får fortsätta med det men för nya katalogägare är det inte tillåtet. anisationsnummer Sid 17/21

18 4 Förklaring till Format och Multiplicitet Nedanstående datatyper för tidpunkter/-intervall utgår från ISO 8601 om inte annat anges. För information om ISO 8601 se t ex För ytterligare behov av specificering av datatyper kontakta RIV-förvaltningsgrupp. (Observera att nedanstående formattabell ska uppdateras av RIV.) Svensk benämning på datatyp Sant/Falskt/ Tomt Förkortning Datatyp enligt ISO Engelsk benämning enligt ISO Förklaring S/F/T BL Boolean Kan antingen vara sant, falskt eller tomt. Sant/Falskt S/F BN Boolean not null Kan antingen vara sant eller falskt. Kodat värde med text och OID KTOV CD Coded value Identifiering av berört kodverk/klassifikation (genom sk OID) samt aktuell kod och text Exempel: A00.9 Kolera, ospecificerat OID för KSH97 v97 mycket allvarlig kolera kod K aktuellt kodvärde text TX klartext kodverk OID identifierng av berört kodverk/ klassifikation version TX kodverkets version förtydliga nde TX används t ex vid förtydligande av kod Övrigt Instans identifierare II II Instance Identifier En unik identifikation av en instans, företeelse eller objekt. T.ex. remissid, personnummer, HSA-id. Exempel: MMÅÅDD-XXXX OID för personnummer kod CV aktuellt kodvärde kodverk OID identifierng av berört kodverk/klassifikation Datapaket DP ED Encapsulate d data Används för att ange typ av bild, ljud och andra multimediadata detta specificeras senare vid behov (för information kontakta RIV förvaltningsgrupp) anisationsnummer Sid 18/21

19 Svensk benämning på datatyp Förkortning Datatyp enligt ISO Engelsk benämning enligt ISO Förklaring Värde VÄ Uttrycker värdets datatyp och sort värde värdetyp Kodat värde aktuellt värde värdetsdatatyp enhet Text värdets enhet Kvantitet KV PQ Physical Quantity Uttrycker mängd och sort som resultat av en mätning. Exempel: 10 kg Flertal FLT<x> SET<x> Set Uttrycker ett flertal/upprepningar av angiven datatyp Exempel. FLT<DT> Fritext TXT ST Simple Text Fritext Tele- och datakommunikati on KOM TEL/HL7 TEL/HL7 Beskriver telekommunikationsadresser t.ex. telefonnummer, fax och e-post. Möjlighet till fritext Datum DT Date Date Angivelse av datum. Formatet är ÅÅÅÅMMDD. Det är tillåtet att ange datum med lägre precision, dvs månad eller år. Datatypen kallas fortfarande datum. Formatet är ÅÅÅÅMM respektive ÅÅÅÅ Exempel: Tidpunkt TP TS Point in Time Angivelse av datum och klockslag med exaktheten sekund. Formatet är ÅÅÅÅ-MM-DDThh:mm:ss.xxxxx Det är tillåtet att ange tidpunkt med lägre precision, dvs minut eller timme. Formatet är hhmm respektive hh. Exempel: ÅÅÅÅ-MM-DDThh:mm eller ÅÅÅÅ-MM- DDThh Detta format är enligt ISO8601. För ytterligare behov av datatyper för tidpunkter kontakta RIVförvaltningsgrupp. Tidsintervall IVL ITV<TS> Time interval Angivelse av ett utrymme i tiden. Detta kan anges på 4 sätt: 1. Start och slut anisationsnummer Sid 19/21

20 Svensk benämning på datatyp Förkortning Datatyp enligt ISO Engelsk benämning enligt ISO Förklaring 2. Start och varaktighet 3. Varaktighet och slut 4. Varaktighet (utan relation till realtid) Formatet är P[tY][mM][dD][T[hH][mM][s[.s]S]] där uppgifter inom [ ] är valfria. Av de första 3 krävs två separata värden åtskilda av /. Exempel: T13:00:00Z/ T15:30:00Z T13:00:00Z/P1Y2M10DT2H30M 3. P1Y2M10DT2H30M/ T15:30:00Z 4. PT2H31M26.34S, dvs jordbävningen pågick i 2 timmar, 31 minuter och 26,34 sekunder Webbadress URL URL Kolumn Multiplicitet (antal möjliga förekomster) Kod, ex Förklaring 1(1..1) En förekomst 0..1 Ingen eller en förekomst 0..* Ingen eller många förekomster 1..2 En till två förekomster 1..* En till många förekomster anisationsnummer Sid 20/21

21 Referenser [1] HSA-schema tjänsteträdet version 4.5.xls [2] RIV Informationsspecifikation HSA Struktur och innehåll version 4.5 anisationsnummer Sid 21/21