Denna tillämpningsanvisning beskriver hur de värdemängder och kodrelationer som finns i den Nationella läkemedelslistan hämtas och hur en kod valideras.

1. Verksamhetsbeskrivning

Syftet med denna tillämpningsanvisning är att beskriva hur de värdemängder och kodrelationer som finns i den Nationella läkemedelslistan kan hämtas. Tillämpningsanvisningen beskriver också hur en kod valideras.

När anslutande system hämtar, skapar eller uppdaterar en resurs (till exempel en förskrivning) används värdemängder och kodrelationer från Nationella läkemedelslistan. Värdemängderna och kodrelationerna hämtas via tjänstegränssnitten för Nationella läkemedelslistan.

Ett kodverk är en uppsättning koder och termer som ska användas för ett särskilt syfte. Ett sådant syfte kan till exempel vara för att ange administreringsmetod på en förskrivning. Kodverken är tillgängliga i Nationella läkemedelslistan via FHIR:s resurs "Value set". "Value set" översätts till värdemängd på svenska. När kodverk och värdemängder omnämns i denna handbok, avses samma sak.

Kodrelationer är tillgängliga i Nationella läkemedelslistan via FHIR:s resurs ConceptMap. En kodrelation visar hur värdemängder eller koder förhåller sig till varandra. Den kan visa:

• hur koder från olika begreppssystem förhåller sig till varandra, till exempel en UCUM-kod och en Snomed CT-kod.
• hur koder från olika värdemängder förhåller sig till varandra, till exempel vilka preciserade administreringsställen som kan föreslås för ett visst administreringsställe.

Här finns dokumentation som beskriver kodverkens och kodrelationernas syfte och innehåll:

• Kodverk och kodrelationer

Här finns vägledningar som beskriver hur anslutande system kan visa och använda kodverken i sina användargränssnitt:

• Så kan ditt vårdsystem använda kodverk och kodrelationer på förskrivningar
  
• Så kan ditt apotekssystem använda kodverk och kodrelationer på förskrivningar

1.1. Behörighetsroller 

Följande behörighetsroller berörs av denna tillämpningsanvisning:

• maskin-till-maskin

En definition av behörighetsrollerna finns på sidan Roller.

1.2. Termer och definitioner

En beskrivning av samtliga termer som används i denna tillämpningsanvisning går att hitta på sidan Termer och begrepp i Handboken.

1.3. Resurser

I tabell 1 nedan listas de informationsresurser, FHIR-resurser och FHIR-profiler som hämtas i denna tillämpningsanvisning.

Se Generell beskrivning av FHIR för en mer generell beskrivning av FHIR-resurser och FHIR-profiler i Nationella läkemedelslistan.

Tabell 1 - Resurser

2. Delfunktioner i tillämpningsanvisningen

2.1. Förkrav 

Innan delfunktioner i denna tillämpningsanvisning kan tillämpas måste kraven i kravområde 1 och kravområde 3 i dokumentet Spårbarhetskrav vara uppfyllda. Se även krav TK 10 och TK 11 i Krav på anropsresultat och felhantering.

2.2. Delfunktion 1: Hämta aktiva värdemängder

Beskrivning av tillämpning

Denna delfunktion kan användas av anslutande system för att kunna uppfylla de krav som beskrivs på sidan Hantering av kodverk och därigenom säkerställa att endast kod från den aktiva versionen av en värdemängd används. Genom att hämta aktiva värdemängder kan anslutande system hålla och visa aktuell information om innehåll i värdemängderna. Systemet kan antingen hämta den aktiva versionen av alla värdemängder eller den aktiva versionen av en specifik värdemängd. En aktiv version innehåller enbart koder som är gällande.

Om en kod inte hittas i en aktiv värdemängd så kan delfunktion 3 eller delfunktion 4 användas för att kontrollera om koden tidigare har varit aktiv och vad den då hade för term/klartext.

Samtliga värdemängder finns i tabeller på sidan Hantering av kodverk.

Värdemängder som är frivilliga att använda

Värdemängderna i tabell 2 är frivilliga att använda. Om någon av dessa används omfattas de av krav som ersatt 34:1:1, se tabell på sidan Hantering av kodverk. Värdemängderna innehåller koder som inte får anges på resurser (till exempel förskrivningar) men som kan användas för att implementera kodrelationer Observera att värdemängderna i tabell 2 enbart beskriver de koder som har kodrelationer och därför inte innehåller alla koder som finns i andra källor.

Tabell 2 - Värdemängder som kan användas för att implementera kodrelationer. Dessa är frivilliga att använda.

Berörd resurs: Värdemängd

Resurser som berörs beskrivs i Sökning och hämtning per resurs. 

Returnerad resurs: Värdemängd

Resurser som returneras beskrivs i Hämtade informationsresurser.

2.3. Delfunktion 2: Hämta kodrelationer

Beskrivning av tillämpning

Denna delfunktion kan användas för att anslutande system ska kunna hålla aktuell information om hur värdemängder eller koder förhåller sig till varandra. Anslutande system kan antingen hämta alla kodrelationer eller en specifik kodrelation. Läs mer på sidan Kodverk och kodrelationer, samt se tabell över kodrelationer på sidan Hantering av kodverk.

Berörd resurs: Kodrelation

Resurser som berörs beskrivs i Sökning och hämtning per resurs. Se även avsnitt 1 för hänvisning till teknisk beskrivning och exempelanrop i Simplifier.

Returnerad resurs: Kodrelation

Resurser som returneras beskrivs i Hämtade informationsresurser.

2.4. Delfunktion 3: Hämta historiska versioner av en specifik värdemängd

Beskrivning av tillämpning

Denna delfunktion kan användas för att läsa in historiska versioner av en specifik värdemängd från Nationella läkemedelslistan. Då kan anslutande system hämta och visa betydelsen, dvs. termen/klartexten av en kod som är inaktiv. Det kan till exempel vara när systemet hämtar en befintlig förskrivning som innehåller en kod som är inaktiv, och därför inte finns i den aktuella värdemängden. För att hitta kodens betydelse i en historisk värdemängd kan systemet nyttja denna delfunktion och får då tillgång till alla versioner av den specifika värdemängden, det vill säga både aktiv och historiska (inaktiva).

Berörd resurs: Värdemängd

Resurser som berörs beskrivs i Sökning och hämtning per resurs. Se även avsnitt 1 för hänvisning till teknisk beskrivning och exempelanrop i Simplifier.

Returnerad resurs: Värdemängd

Resurser som returneras beskrivs i Hämtade informationsresurser.

2.5. Delfunktion 4: Validera kod

Beskrivning av tillämpning

Denna delfunktion kan exempelvis användas för en kod som inte längre är aktiv i en värdemängd – för att validera om den har varit giltig, och vilken term som då fanns för den koden. Detta kan behövas för förskrivningar innehållande inaktiva koder som ändå behöver kunna läsas.

Delfunktionen kan användas för att anslutande system ska kunna:

• kontrollera om en kod är aktiv i angiven värdemängd.
  • en term kan också anges och då kontrolleras att den överensstämmer med aktuell term (Term).
  • en tidpunkt kan också anges och då kontrolleras koden vid angiven tidpunkt, eller fram till och med angiven tidpunkt beroende på anrop.
    • om endast datum anges så sätts klockslaget automatiskt till 00.00.
  • en version kan också anges och då sker kontrollen mot den angivna versionen av värdemängden.

Om koden är aktiv enligt ovanstående kriterier, returneras ett svar att koden finns samt dess term (Term).

Berörd resurs: Värdemängd

Resurser som berörs beskrivs i Sökning och hämtning per resurs. Se även avsnitt 1 för hänvisning till teknisk beskrivning och exempelanrop i Simplifier.

Returnerad resurs: Parameters

Resurser som returneras beskrivs i Hämtade informationsresurser.

2.6. Delfunktion 5: Översätta kod, dvs. hämta kodrelationer utifrån en given kod

Beskrivning av tillämpning

Denna delfunktion kan användas för att anslutande system ska kunna hämta alla kodrelationer för en given kod i en specifik värdemängd. Detta kan användas för att översätta en kod i en värdemängd till en jämförbar eller relaterad kod i en annan värdemängd.

Om det finns relationer returneras dessa som en lista med koder. För varje kod returneras även vilken typ av relation den har till den givna koden.

Kodrelationer som omfattas finns i tabell på sidan Hantering av kodverk.

Berörd resurs: Kodrelation

Resurser som berörs beskrivs i Sökning och hämtning per resurs. Se även avsnitt 1 för hänvisning till teknisk beskrivning och exempelanrop i Simplifier.

Returnerad resurs: Parameters

Resurser som returneras beskrivs i Hämtade informationsresurser.

3. Hanterad information

3.1. Meddelandehuvud

Information i meddelandehuvudet ska för denna tillämpningsanvisning anges enligt regler i tillämpningsmönster 2.1. Hämta utan säkerhetsintyg i Informationsspecifikation – meddelandehuvud.

3.2. Sökning och hämtning per resurs

Värdemängd

Sökning

Tabell 3 - Sökning av värdemängder via kod

Hämtning

Tabell 4 - Hämtning av värdemängder

Operation för att validera kod 

Se exempelanropet "validate code" i Simplifier och Validera kod - $validate-code för mer information.

Indata 

Information som ska bifogas vid anrop till FHIR-operationen $validate-code anges i tabell 5.

Tabell 5 - Indata för validera kod

Returnerad information

Tabell 6 - Returnerad information för validera kod

Kodrelation

Hämtning

Tabell 7 - Hämtning av kodrelationer mellan värdemängder

Operation för att översätta kod

Se exempelanropet "translate a code" i Simplifier och Översätta kod - $translate för mer information.

Indata 

Information som ska bifogas vid anrop till FHIR-operationen $translate anges i tabell 8.

Tabell 8 - Indata för översätta kod

Returnerad information

Tabell 9 - Returnerad information för översätta kod

3.3. Hämtade informationsresurser

Informationsresurs Värdemängd

Resursen "Värdemängd" beskrivs i informationsspecifikationen Värdemängd – NLLValueSet.

Informationsresurs Kodrelation

Resursen "Kodrelation" beskrivs i informationsspecifikationen Kodrelation – NLLConceptMap.

3.4. Filtreringsregler

Här beskrivs eventuell filtrering av information för det angivna ändamålet och åtkomsttypen. Filtrering kan ske på resursnivå eller på information i enskilda termer i en resurs.

Resurser

Ingen filtrering av resurser utförs.

Termer

Ingen filtrering av termer utförs.

4. Regler och kontroller

4.1. Generella verksamhetsregler

Inga generella verksamhetsregler används i denna tillämpningsanvisning.

4.2. Automatiska kompletteringar

Inga automatiska kompletteringar finns för denna tillämpningsanvisning.

4.3. Specifika verksamhetsregler

Inga specifika verksamhetsregler finns för denna tillämpningsanvisning.

4.4. AFF-kontroller och kontrollsamlingar

Inga AFF-kontroller och kontrollsamlingar finns för denna tillämpningsanvisning.

5. Presentationskrav

Presentationskrav finns på sidan Generella presentationskrav för anslutande aktör och system.

5.1. Rekommendationer

REKOMMENDATION

Om föreslaget urval består av flera värden bör inte systemet visa något av dem som förvalt. Det gäller även då det inte finns något föreslaget urval, det vill säga då hela innehållet i ett kodverk ska visas för användaren. Undantag från detta kan exempelvis göras i fördefinierade mallar för att underlätta för användaren.

Versionshistorik