Brugermanual for Terminologiadministrationsapplikationen

Nærværende brugermanual beskriver hvordan vedligehold af terminologi, herunder klassifikationer, anvendt i eHealth Infrastrukturen foretages gennem Terminologiadministrationsapplikationen. Terminologiadministrationsapplikationen tilbyder en brugergrænseflade til oprettelse og vedligehold af primært FHIR CodeSystem og ValueSet.

Terminologiadministrationsapplikationen understøtter to servere med hver deres formål. Der eksisterer den generiske terminologi server, og en yderligere server specifikt for vedligehold af ID registre og kodede værdier for spørgeskema spørgsmål og svar til dokumentdeling. Sidstenævnte server omtales Spørgeskemakodebanken.

Målgruppen for brugermanulen er personer, der skal vedligeholde terminologi i eHealth Infrastrukturen.

Vedligeholdelse af terminologi anvendt i infrastrukturen bør ske i overensstemmelse med de regler og principper, der er beskrevet i Vejledning om Governance for Terminologi i eHealth Infrastrukturen. Der opfordres derfor kraftigt til at læseren forud gør sig bekendt med indholdet i vejledningen.

Nøgleordene SKAL, MÅ IKKE, BØR, BØR IKKE, KAN, MÅ skrevet i versaler skal fortolkes som beskrevet i RFC2119.

Terminologiadministrationsapplikationen er baseret på open-source implementationen Trifolia-on-FHIR og bruger eHealth infrastrukturens Terminologiserver som backend.

Handlinger foretaget i applikationen har umiddelbar effektuering uden mulighed for at fortryde når der gemmes med Save. Dette har betydning for rækkefølgen, som ændringer bør foretages i. Mens ændringer kan planlægges top-down med udgangspunkt i for eksempel et ValueSet, så bør de udføres bottom-up. Planlægges tilføjelse af et nyt koncept til et CodeSystem og et eller flere ValueSet, så bør ændringen udføres først i CodeSystem og dernæst i de pågældende ValueSet.

Handlinger, der ikke tillades grundet governance-regler, bliver i visse tilfælde først fanget når der gemmes.

FHIR ressourcerne FHIR CodeSystem, ValueSet og ConceptMap indeholder et:

Fremsøg CodeSystem ved:

Opret CodeSystem ved:

Tilføjelse af koncepter kan ske ved oprettelse eller ved ændring af eksisterende CodeSystem. Tilføj koncept ved:

Ændring af et koncept KAN ske frit i et CodeSystem med status Draft. Når det først er publiceret (med status Active) BØR ændring ske med stor omtanke jævnfør beskrivelserne i [Vejledning til governance]. Ændring af koncept i publiceret CodeSystem MÅ IKKE ændre ved betydningen og derfor højst være syntaktisk, for eksempel rettelse af stavefejl.

Ændr koncept ved:

Fjernelse af koncept fra et CodeSystem KAN gennemføres, når CodeSystem har status Draft.

Fjern koncept (fra CodeSystem med status Draft) ved:

Inden publicering BØR indholdet af et CodeSystem gennemgås omhyggeligt, da koncepter efterfølgende ikke kan fjernes eller skifte kode.

Publicer et CodeSystem ved:

Udfasning af et koncept foretages ved:

Ved ændring af et aktivt (publiceret) CodeSystem bevirker tryk på Save i panelet Code System, at der automatisk sættes ny business-version i feltet Version. Versionen er på formen YYYY-MM-dd’T’HH:mm:ss og sættes automatisk til dags dato.

Udfasning af et CodeSystem foretages ved:

Sletning af et kladde CodeSystem (med status Draft) foretages ved:

Fremsøg et ValueSet ved:

Opret ValueSet ved:

Tilføj alle koncepter fra et CodeSystem til et ValueSet ved:

Hvis der efterfølgende tilføjes koncepter til pågældende CodeSystem vil de også indgå i pågældende ValueSet ved expansion.

Tilføj udvalgt koncept fra et CodeSystem til et ValueSet ved:

Der ændres ikke på hvilke koncepter, der indgår i pågældende ValueSet, hvis der efterfølgende tilføjes koncepter til det pågældende CodeSystem.

Tilføj alle koncepter fra et ValueSet til et ValueSet ved:

Fjern et koncept eksplicit udpeget i et include i et ValueSet ved:

Fjern include af CodeSystem eller ValueSet i et ValueSet ved:

Definitionen af et ValueSet i Terminologiadministrationsapplikationen er intentional. Ønskes der overblik over hvilke værdier, der indgår i en expansion af nuværende definition af et ValueSet, kan expansion afprøves.

Afprøv expansion for et ValueSet ved:
. Opret eller fremsøg ValueSet
. Tryk på symbolet med firkant med brudte linier (Expand this value set) for pågældende ValueSet i panelet Value Sets
. Tryk på Expand i panelet Expand Value Set

Resultatet er efterfølgende vist sammen med status, for eksempel Expansion complete.

Inden publicering BØR indholdet af et ValueSet gennemgås omhyggeligt, da koncepter efterfølgende ikke umiddelbart kan fjernes.

Publicer et ValueSet ved:

Ved ændring af et ValueSet bevirker tryk på Save i panelet Value Set, at der automatisk sættes ny business-version i feltet Version. Versionen er på formen YYYY-MM-dd’T’HH:mm:ss og sættes automatisk til dags dato.

Udfasning af et ValueSet foretages ved:

Sletning af et kladde ValueSet (med status Draft) foretages ved:

Fremsøg et NamingSystem ved:

Søgeresultatet kan være nul, et eller flere NamingSystem.

Se Import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap filer.

Se Import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap filer.

Fremsøg et ConceptMap ved:

Søgeresultatet kan være nul, et eller flere ConceptMap.

Se Import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap filer.

Se Import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap filer.

For CodeSystems i Spørgeskemakodebanken gælder følgende regler:

Use Context tilknyttes et CodeSystem under "Additional" fanen i CodeSystemet. Use Context sættes ved at:

Se Vedligeholdelse af CodeSystem for yderligere beskrivelse af vedligeholdelse af CodeSystems.

For NamingSystems i Spørgeskemakodebanken gælder følgende regler:

Følgende fil er en skabelon som kan bruges til at udfylde et NamingSystem til brug som ID register på Spørgeskemakodebanken: skabelon.json. Værdierne som skal udfyldes/opdateres er angivet med {{ }} rundt om. Følgende er regler/vejledning for de enkelte felter:

Se Vedligeholdelse af NamingSystem for general info om vedligehold af NamingSystems.

På Code Systems under fanen "Internal (FHIR)" samt de andre faner (undtagen External) er der beskrevet CodeSystem vedligeholdt af HL7 FHIR og HL7. Tilsvarende findes for ValueSet på Value Sets Defined in FHIR og ConceptMap på Mappings between Value Sets Defined in FHIR.

Disse er tilgængelige i Terminologiservicen på en måde, hvor de ikke optræder som CodeSystem/ValueSet/ConceptMap tilgængelige i databasen og dermed for Terminologiadministrationsapplikation.
Adgang til disse kan ske gennem Terminologiservice-operationerne CodeSystem/$lookup og ValueSet/$expand.

Det fremgår af definitionerne af profiler i eHealth ImplementationGuide hvorvidt der anvendes CodeSystem og ValueSet vedligeholdt af HL7 og HL7 FHIR. De kan tillige være brugt i eHealth ValueSet.

Foretag import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap fil ved:

Import af FHIR CodeSystem/ValueSet/NamingSystem/ConceptMap bruges til både oprettelse og opdatering af ressourcer. Applikationen differentierer imellem oprettelse og opdatering, baseret på om ressourcen i filen indeholder "id" attributten. Hvis "id" ikke er oplyst, antager applikationen at der forsøges at oprette en ny ressource. Man bliver mødt med validerings fejl: "Validation error: Resource.uniqueId is not unique", hvis man forsøger at opdatere en resource uden at oplyse dets "id". "Id" værdien kan findes ved at fremsøge den allerede oprettet resource.

Eksempel på "id" attributten på et NamingSystem:

De eksterne klassifikationer International SNOMED CT, dansk extension af SNOMED CT (SNOMED CT Denmark Extension) og LOINC distribueres af deres respektive definerende/administrerende organisationer. Import af disse foretages via andre værktøjer i eHealth Infrastrukturen.

Denne opgave udføres af eHealth Infrastruktur-drift.

Terminologi vedligeholdes i eHealth Infrastrukturens produktionsmiljø via Terminologiadministrationsapplikationen, via FHIR filer og via import af SNOMED CT og LOINC.

Når et nyt eHealth Infrastruktur-miljø spinnes op, kan der via andre værktøjer exporteres terminologi fra produktionsmiljøet og importeres til det nye miljø.

Denne opgave udføres af eHealth Infrastruktur-drift.