Terminologi

Kodverk som används i VGR:s profiler ska vara vara publikt tillgängliga. Det föredragna alternativet är att kodverk är publicerade på en öppen kodverkstjänst. I andra hand publiceras kodverket inuti IG:n där det används.

Kodverk ska ha ett unikt och beständigt ID som är resolverbart och i övrigt följa VGR:s Enhet för Informatik och Standardiserings regler för kodverk.

Bindningstyp

Element i en FHIR-profil kan ha sina ValueSets olika hårt knutna till sig. Det finns fyra styrkor av bindning; example, preferred, extensible, och required.

Som grundprincip lämnas bindningen och kodverket så öppet som möjligt. Vid tillämpningar som endast ska användas för att hämta information finns sällan anledning att snäva in kodverket. Vid tillämpningar som ska skriva information bör kodverket begränsas så att det följer VGR:s referensinformationsarkitektur.

Se även:

CodeSystem

Ett CodeSystem ska i första hand kunna härledas via uri till terminologitjänst med stöd för FHIR API. Om detta ej är möjligt ska CodeSystemet representeras i sin helhet som CodeSystem-artefakt i IG. Ett CodeSystem som ej kan representeras genom fungerande referens till terminologitjänst ska innehålla annan referens till definition av CodeSystemet, t ex KOLLI eller annan plats som finns att nå för läsaren

CodeSystems i basprofiler

Endast officiellt, på regional nivå, beslutade kodverk får användas i Basprofil. Inga undantag.

CodeSystems i tillämpningsprofiler

Officiellt, på regional nivå, beslutade kodverk bör användas i tillämpningsprofiler, men undantag kan medges för att undvika stopp i standardiseringsflaskhalsen.

Namn på Codesystem

namn
Skrivs enligt mall <Tillämpning>CS
Om kodverket baseras på ett VGR-kodverk skall det namnges inklusive prefix “VGRKV”. Exempel: SarskildbetalarstatusCS, VGRKVvardformCS

titel
Skrivs enligt mall <Tillämpning>CodeSystem
Exempel: Sarskildbetalarstatus CodeSystem, VGRKVvardform CodeSystem

Declaration

CodeSystem: <kodverkets namn>

Keywords

Id: <kodverkets namn>
Description: <Beskrivning av kodverket, max 200 tecken. Om kodverket kommer från KOLLI, översätt det som står i “Beskrivning av innehållet” till engelska och skriv här>
Title: <kodverkets titel>

Caret Paths

^status = #active
^experimental = false
^language = #sv-SE
^content = #complete
^caseSensitive = true

Exempel

CodeSystem: SarskildBetalarstatusCS
Id: SarskildBetalarstatusCS
Description: "Specifies the type of regulation to be used for identifying the payer for individuals who cannot be identified as registered residents in Sweden at the start of the healthcare encounter."
Title: "SarskildBetalarstatus CodeSystem"
* ^status = #active
* ^experimental = false
* ^language = #sv-SE
* ^content = #complete 
* ^caseSensitive = true

ValueSet

Ett ValueSet innehåller alla eller några koder från ett eller flera CodeSystem.

ValueSets i basprofiler

ValueSets som ska användas regionalt kan definieras i Basprofil och därmed ärvas till samtliga tillämpningar i VGR. Beroende på bindningstyp (se ovan) blir detta olika begränsande.

ValueSets i tillämpningsprofiler

ValueSet som endast används inom den aktuella tillämpningen definieras i tillämpningsprofilen. Detta är särskilt användvbart för profiler som ska användas för att lagra eller dela information.

Namn på ValueSet

namn
Skrivs enligt mall <Tillämpning>VS
Om kodverket baseras på ett VGR-kodverk skall det namnges inklusive prefix “VGRKV”. Exempel: SarskildbetalarstatusVS, VGRKVvardformVS

titel
Skrivs enligt mall <Tillämpning>ValueSet
Exempel: Sarskildbetalarstatus ValueSet, VGRKVvardform ValueSet

Declaration

ValueSet: <valuesetet:s namn>

Keywords

Id: <valuesetet:s namn>
Description: <Kort beskrivning av valuesetet, max 200 tecken>
Title: <valuesetet:s titel>

Caret Paths

^status = #active
^experimental = false
^language = #sv-SE

Exempel

ValueSet: UtfardareAvBetalningsforbindelseVS
Id: UtfardareAvBetalningsforbindelseVS
Description: "Specifies which organization will pay for the healthcare encounter when it is not VGR"
Title: "UtfardareAvBetalningsforbindelse ValueSet"
* ^status = #active
* ^experimental = false
* ^language = #sv-SE