Informationsspecifikation SDK adressbok

participantIdentifier

String

Unik identifierare av deltagarorganisationen.

Giltiga värden: Enligt specifikation ”SDK-federationens anpassningar mot plattform för eDelivery” avsnitt 2.1 (ISO6523 ICD)

1..1

organizationNumber

String

Svenskt organisationsnummer är obligatorisk.

Se även regelverk för underorganisation (Type)

Giltiga värden:

• Svenskt organisationsnummer

1..1

name

String

Officiellt namn för deltagarorganisation (organisationsnamn). Max 256 tecken.

T.ex. Arbetsförmedlingen

1..1

alternateName

String

Inofficiell alternativ benämning för organisation. Kan typiskt användas för att andra parter lättare ska förstå vilken organisation det avser (populärnamn).

T.ex. Arbetsförmedlingen - Swedish public employment service

0..1

description

String

Textuell beskrivning av deltagarorganisationen. Max 1024 tecken.

T.ex. Vi är Sveriges största förmedlare av arbeten. Vårt jobb är att så effektivt som möjligt föra samman dem som söker medarbetare med dem som söker jobb.

0..1

countryCode

string

Deltagarorganisationens landstillhörighet.

Giltiga värden:

Tvåställig bokstavskod enligt standarden ISO 3166 (alpha-2).

Ex: SE, NO, DK, FI

1..1

createdAt

DateTime

Tidsstämpel från och med tidpunkt när organisation skapats.

Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z

1..1

updatedAt

DateTime

Tidsstämpel från och med tidpunkt när organisation uppdaterats.

Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z

0..1

Giltiga kodverk (validCodeSystems)

Kodverk(struktur och sökkodverk) som är giltiga/används av deltagarorganisationen.

0..*

validCodeSystems .system

String

Kodverkets identifierare (OID)

1..1

validCodeSystems .name

String

Kodverkets namn

1..1

validCodeSystems .version

String

Kodverkets version

1..1

Länskod (RegionCode)

codeType

Deltagarorganisationens geografiska hemvist - länskod.

Regler:

• En deltagarorganisation som utlämnar länskod har nationell geografisk hemvist. Dvs är tillgänglig i hela landet.
• En deltagarorganisation KAN registrera en eller flera geografiska hemvister

Giltiga värden:

• Länskod enligt SCBs definition.

1..*

Kommunkod (municipalityCode)

codeType

Deltagarorganisationens geografiska hemvist - kommunkod.

Regler:

• En deltagarorganisation som utlämnar kommunkod är tillgänglig inom hela länet.
• En deltagarorganisation KAN registrera en eller flera geografiska hemvister

Giltiga värden:

• Kommunkod enligt SCBs definition.

1..*

Type

String

Egenskap för att särskilja deltagarorganisation och underorganisation.

• En underorganisation av “Type OU“ kan kopplas till deltagarorganisation av “Type O“.

Giltiga värden:

O = Organisation (deltagarorganisation)

UO = Underorganisation

Regler underorganisation:

1. Regelverk för underorganisation (type = UO)

2. Underorganisation kan aldrig ha samma namn som någon annan organisation inom aktuell organisationshierarki (dvs inom samma “deltagarorganisation”).

3. Underorganisation (type = UO) kan ha samma organisationsnummer som annan underorganisation inom samma deltagarorganisation.

4. Underorganisation (type = UO) kan ha samma organisationsnummer som annan organisation utanför deltagarorganisationen men en varning ges till administratören.

5. Underorganisation (type = UO) med samma namn som annan deltagarorganisation - systemet varnar administratör och extra godkännande krävs.

6. Underorganisation (type = UO) med samma namn som annan organisation utanför egen deltagarorganisation ger ingen varning

1..1

Ägarform (Managementcode)

codeType

Deltagarorganisationens ägarform.

Giltiga värden enligt kodverk ägarform OID 1.2.752.129.2.2.1.14

Giltiga värden:

Region (Region inklusive dess nämnder och kommunala bolag)

• Kommun (Kommun inklusive dess nämnder och kommunala bolag)
• Statlig (Statliga myndigheter (Avser statliga enheter, ej staten som sådan))
• Privat (Privata utförare av offentligt uppdrag
• Kan avse AB, HB, Kommanditbolag)

1..1

publicProvider (Offentlig uppdrag/huvudman)

Boolean

Markerar om deltagarorganisationen är offentligt finansierad har ett offentligt uppdrag

true = representerar offentlig huvudman

1..1

identifier

String

Inom deltagarorganisationen unik identitet (teknisk adress) för funktionen. En identifierare får ej vara skiftlägeskänslig.

Godkända tecken är alfanumerisk teckenuppsättning (A-Z, 0-9) samt följande tecken !#$%&'*+-/=?^_`{|}~

Rekommendation:

En funktionsadress kan utformas enligt rekommendation (uri format).

schema:funktions-id.underOrganisation:icd-kod:ParticipantIdentifier

Ex: sdk:funktions-Id.underorganisation:0203:inera.se​

1..1

unitName

String

Organisatorisk enhet som verksamhetsfunktion (Addresses) tillhör. (enhetsnamn, Organisatorisk Enhet). Max 256 tecken.

• Enhetens officiella namn

0..1

name

String

Funktionens namn. Max 256 tecken.

T.ex. Socialjour

1..1

description

String

Beskrivning av funktionen. Max 1024 tecken. T.ex. När du har fått ett beslut om att anställa någon med stöd från oss behöver du varje månad lämna in den individbaserade arbetsgivardeklarationen till Skatteverket för att få din ersättning.

0..1

categories

String

Lista med egendefinierade sökord. Egen kodning eller etikett av funktionsadress.

0..1

activatedAt

Datetime

Tidsstämpel från och med tidpunkt när funktionen är aktiverad.

Om denna är utelämnad (ej anges) räknas funktionen som aktiverad, såvida inte deactivatedAt har passerats.

Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z

0..1

deactivatedAt

Datetime

Tidsstämpel tidpunkt varefter funktionen är inaktiverad.

Om denna är utelämnad styr enbart activatedAt huruvida funktionen är aktiv eller ej.

Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z

0..1

Koder (codes)

codeType

Kodade värden. Koder (t.ex. sök koder, sök ord) används för att stödja strukturerad sökning av funktioner.

• Strukturkodverk
• Sökkodverk

T.ex. En fastslagen kod för verksamhetsprocess/funktion “orosanmälan” för att möjliggöra exakt sökning med hjälp av sök kod/sök kod.

0..*

Länskod (regionCode)

codeType

Funktionens geografiska hemvist – länskod.

Regler:

• En funktion ärver deltagarorganisationens geografiska hemvist
• En funktion som saknar länskod har nationell geografisk hemvist (nationell täckning).
• En funktion kan registrera en eller flera geografiska hemvister (som då skiljer sig från deltagarorganisationens geografiska hemvist)

Giltiga värden:

• Länskod enligt SCBs definition.

0...*

Kommunkod (municipalityCode)

codeType

Funktionens geografiska hemvist - kommunkod.

Regler:

• En funktion ärver deltagarorganisationens geografiska hemvist
• En adress som saknar kommunkod är tillgänglig inom hel länet.
• En funktion kan registrera en eller flera geografiska hemvister (som då skiljer sig från deltagarorganisationens geografiska hemvist)

Giltiga värden:

• Länskod enligt SCBs definition.

0..*

system

Identifierare av kodverk (OID)

1..1

code

String

Kod eller uttryck definierad enligt kodverket.

1..1

text (displayName)

String

Den läsbara representationen (klartext) av koden eller uttrycket som definieras av kodverket.

1..1

displayText

String

Den läsbara representationen (klartext) av koden eller uttrycket som definieras av kodverket.

0..1

additionalInfo

String

Läsbar information- eller beskrivning av kodens betydelse.

0..1