På denna sida finns information och krav kopplade till användning och hantering av koder och kodverk som används i den Nationella läkemedelslistan.

1. Inledning

Ett kodverk är en uppsättning kodade begrepp 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. Kodverk publiceras via FHIR-resursen ValueSet. ValueSet översätts till värdemängd på svenska. När kodverk och värdemängder omnämns avses samma sak i texten nedan.

När anslutande system hämtar, skapar eller uppdaterar en informationsresurs (till exempel en förskrivning) används kodade värden. Alla informationsresurser i den Nationella läkemedelslistan beskrivs av en FHIR-profil där det bland annat framgår vilka element som kan förekomma samt deras respektive datatyp,  exempelvis "String" eller "DateTime". I FHIR-profilen är alla element av kodad typ kopplade till en värdemängd. Värdemängden innehåller de koder som är giltiga för de tillämpningar som profilen avser. 

Ett exempel på användning av element med kodade värden:
I profilen som beskriver strukturen i en förskrivning (MedicationRequest) är attributet "status" knutet till värdemängden "Förskrivningsstatus" (medication-request-status). Värdemängden "Förskrivningsstatus" innehåller 5 koder varav en av koderna är "active", vilken har den användarvänliga texten (klartext, patientvänlig synonym) "Aktiv".

Profilerna och värdemängderna täcker i många fall flera olika tillämpningar. I tillämpningsanvisningarna framgår det om det finns mer specifika regler för när de olika koderna ska eller får användas.

En hjälpresurs för hantering av koder i Nationella läkemedelslistan är FHIR-resursen Concept Map. Concept Map översätts till kodrelation på svenska. En kodrelation visar hur koder i olika värdemängder 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 det mer information som berör kodverk:

• Kodverk och kodrelationer - Här finns dokumentation som beskriver kodverkens och kodrelationernas syfte och innehåll.
• TA 34 – Hämta värdemängder och kodrelationer - Här beskrivs kodverksrelaterade resurser och operationer i form av en tillämpningsanvisning.
• Generella presentationskrav för anslutande aktör och system - Här finns alla generella presentationskrav inklusive sådana som rör kodverk.
• Inledande teknisk dokumentation - Här finns den tekniska dokumentationen rörande kodverksrelaterade resurser och operationer.
• Exempel på värdemängder - Här finns exempel på vad en värdemängd (ValueSet) innehåller.
• Exempel på kodrelationer - Här finns exempel på vad en kodrelation (ConecptMap) innehåller.

2. Kravområden

2.1. Kravområde 1 - Tillämpning

Nedan beskrivs allmänna krav som är relaterade till kodade begrepp och hur användaren kommer i kontakt med dessa. På sidan Generella presentationskrav för anslutande aktör och system redovisas de krav som gäller vid visning av kodade värden. Nedan listas presentationskraven med länkar.

2.1.1. Vid presentation för användaren måste kodat värde översättas till klartext

Alla begrepp i en värdemängd innehåller dels en kod (attributet code i resursen Value Set), dels en användarvänlig text benämnd klartext (attributet display i resursen ValueSet). När innehållet i en informationsresurs, t ex förskrivning, visas för användaren ska koden översättas till den användarvänliga texten.

KRAV

Krav-ID: Se Generella presentationskrav P30 (tidigare 34:P.1)

2.1.2. Samtliga kodade begrepp ska vara tillgängliga

När användaren matar in eller väljer ett kodat begrepp är grundregeln att samtliga begrepp i värdemängden ska vara tillgängliga för användaren. För vissa värdemängder kan det finnas undantag vilket i så fall framgår av handboken i till exempel verksamhetsflöden och tillämpningsanvisningar.

KRAV

Krav-ID: Se Generella presentationskrav P32 (tidigare 34:P.3)

2.1.3. Hantering när en hämtad resurs innehåller en okänd kod

En kod blir inaktiv när den inte längre ingår i den aktiva versionen av en värdemängd. Om en informationsresurs, t ex förskrivning, innehåller en kod som inte längre är i bruk måste anslutande system ha funktionalitet för att översätta en inaktiv kod till dess användarvänliga text. Detta kan ske på olika sätt t ex genom att hämta eller mellanlagra äldre versioner av en värdemängd, eller genom att använda operationen $validate-code. Kravet har omformulerats med anledning av att det tidigare kravet 34:1:1 Krav på daglig uppdatering har utgått.

KRAV

Krav-ID: Se Generella presentationskrav P31 (tidigare 34:P.2)

2.1.4. Hantering när en utgången kod används av ett anslutande system

Om ett anslutande system använder en kod som inte längre är i bruk kommer den Nationella läkemedelslistan avvisa anrop för att skapa eller uppdatera en informationsresurs. Detta kan uppstå om systemet inte har uppdaterats med den senaste aktiva versionen av värdemängden där koden ingår. Anslutande system måste ha ett adekvat stöd för att hantera om en sådan situation uppstår alternativt motverka att en sådan situation uppstår. Kravet har tillkommit då det tidigare kravet 34:1:1 Krav på daglig uppdatering har utgått.

KRAV

Krav-ID: HK 1.1 (nytt krav)

2.2. Kravområde 2 - Hämtning och mellanlagring av värdemängder och kodrelationer

För att uppfylla tillämpningskraven ovan måste anslutande system ha tillgång till de värdemängder som används i den Nationella läkemedelslistan. Det finns en stor valfrihet i hur anslutande system åstadkommer det. Nedan beskrivs de krav som rör olika typer av lösningar rörande hämtning och eventuell mellanlagring i det anslutande systemet. Det gäller både värdemängder och kodrelationer om dessa används. OBS! Ett anslutande system behöver bara hantera de kodverk som det finns behov av utifrån de verksamhetsflöden systemet stödjer.

2.2.1. Mellanlagring med automatisk uppdatering

KRAV

Krav-ID: HK 2.1

Om uppdateringen sker via en automatiserad process i det anslutande systemet är det viktigt att informationen hämtas från en betrodd källa. En betrodd källa kan tillhandahålla informationen i annat format än det den Nationella läkemedelslistan använder. Oavsett om informationen hämtas direkt från den Nationella läkemedelslistan via FHIR-resurserna ValueSet och ConceptMap eller via en annan källa måste ett automatiserat flöde baseras på informationen vars källa är den Nationella Läkemedelslistan. Mellanlagrade värdemängder och kodrelationer måste hållas uppdaterade i enlighet med kravområde 3 nedan.

REKOMMENDATION

För att undvika de problem som uppstår när ett anslutande system använder äldre versioner av de kodverk som används i den Nationella läkemedelslistan är rekommendationen att anslutande system uppdateras automatiskt eller semiautomatiskt på daglig basis när så är möjligt.

2.2.2. Mellanlagring med manuell uppdatering

KRAV

Krav-ID: HK 2.2

Om uppdateringen sker via en manuell process av det anslutande systemet är det viktigt att informationen hämtas från en betrodd källa. En betrodd källa kan tillhandahålla informationen i annat format än det den Nationella läkemedelslistan använder. Oavsett om informationen hämtas direkt från den Nationella läkemedelslistan via FHIR-resurserna ValueSet och ConceptMap eller via en annan källa måste ett manuellt flöde baseras på informationen vars källa är den Nationella Läkemedelslistan. Mellanlagrade värdemängder och kodrelationer måste hållas uppdaterade i enlighet med kravområde 3 nedan. 

2.2.3. Automatiskt uppslag utan mellanlagring

KRAV

Krav-ID: HK 2.3

Om värdemängder och kodrelationer inte mellanlagras i det anslutande systemet måste presentationskraven uppfyllas via uppslag mot den Nationella läkemedelslistan i realtid. Rekommendationen är att mellanlagra de kodverk som används i det anslutande systemet men den här metoden kan tillämpas för kodverk som används sällan och viss fördröjning i presentation av information kan accepteras.

2.3. Kravområde 3 - Uppdatering av mellanlagrade värdemängder och kodrelationer

För att uppfylla presentationskraven ovan måste anslutande system ha tillgång till de värdemängder som används av den Nationella läkemedelslistan. Det innebär att det även behövs stöd för att uppdatera värdemängderna när de förändras. Om de kodrelationer som publiceras av den Nationella läkemedelslistan används i det anslutande systemet måste även dessa uppdateras när de ändras. Det finns en stor valfrihet i hur anslutande system hanterar värdemängder och kodrelationer och hur de hålls uppdaterade. Nedan beskrivs de krav som rör hämtning och mellanlagring.

2.3.1. Uppdatering av värdemängder och kodrelationer som ändras fortlöpande

Kodsystem som inte ägs eller förvaltas av E-hälsomyndigheten men används i den Nationella läkemedelslistan uppdateras vid behov och vid en tidpunkt som är oberoende av releasecykeln för den Nationella läkemedelslistan. Dessa värdemängder listas i tabell 1 och 2 nedan.

Information om kommande ändringar i värdemängder och kodrelationer kommuniceras på sidan om Information om kända fel och förändringar, senast en månad innan uppdateringen sker. Kommunicerade ändringar publiceras i en ny version av respektive uppdaterad värdemängd. Undantag gäller för värdemängden Behandlingsorsak där ingen information ges om kommande uppdateringar. OBS! Ändringarna tas i bruk i samband med att värdemängden publiceras varför det är viktigt att anslutande system har stöd för hantering av för dem okända koder.

I tabell 1 och tabell 2 nedan återfinns de värdemängder som omfattas av kravet. Tabell 1 innehåller värdemängder vars koder används i den Nationella läkemedelslistan. Tabell 2 innehåller värdemängder vars koder används ihop med kodrelationer för att översätta från andra kodsystem till de kodsystem som används i den Nationella läkemedelslistan. Koderna i dessa värdemängder kan även hämtas från andra källor (till exempel VARA).

I samband med att en värdemängd uppdateras kommer även berörda kodrelationer att uppdateras.

REKOMMENDATION

E-hälsomyndigheten gör uppdateringar i nedanstående värdemängder och kodrelationer mellan klockan 00.00 och 02.00.  Det rekommenderas därför att anslutande system läser in uppdateringar så snart som möjligt efter klockan 02.00.

Figur 1 - Rutin för värdemängder som ändras fortlöpande

KRAV

Krav-ID: HK 3.1 (ersätter 34:1.1 del 2)

Uppdatering av mellanlagrade värdemängder och kodrelationer, enligt tabell 1, ska ske senast 180 dagar efter att E-hälsomyndigheten publicerat ändringarna.

Tabell 1 - Värdemängder som omfattas av krav på uppdatering inom 180 dagar

Tabell 2 - Värdemängder som kan användas för att implementera kodrelationer och omfattas av krav på uppdatering inom 180 dagar om de används.

Observera att värdemängderna i tabell 2 enbart innehåller de koder som förekommer i de kodrelationer som den Nationella läkemedelslistan publicerar. Det kan förekomma fler koder i de underliggande kodsystemen.

Tabell 3 - Kodrelationer som omfattas av krav på uppdatering inom 180 dagar om de används

2.3.2. Uppdatering av värdemängder som ändras vid release

Värdemängder som förvaltas av E-hälsomyndigheten och ingår i den Nationella läkemedelslistan uppdateras vid behov i samband med en release av den Nationella läkemedelslistan enligt nedanstående beskrivning.

Att koder tillkommer och utgår är naturligt i takt med att kraven på den Nationella läkemedelslistan förändras och även om det sker förhållandevis sällan är det viktigt att förändringarna kan genomföras relativt snabbt, med kontroll och på ett säkert sätt. Det här medför att det finns behov av en fastställd process för hur förändringar genomförs. I dialog med vård- och apoteksaktörer har därför nedanstående förändringsmodell tagits fram för att ge alla parter tydliga spelregler för hur ändringar i olika värdemängder ska gå till.

Alla värdemängder som beskrivs i det här avsnittet har klassificerats utifrån hur stor påverkan en ändring får på anslutande system. Om en ändring i en värdemängd får en stor påverkan (SP) innebär det att anslutande system behöver en längre övergångsperiod, typiskt sett 18 månader eller mer. I speciella fall t.ex vid tvingande lagkrav kan tiden vara kortare. Under övergångsperioden tillhandahålls dubbla API-ingångar med olika funktionalitet. Andra värdemängder kan förändras med ingen eller liten påverkan (LP) enligt nedanstående process.

1. Information om en kommande ändring publiceras på sidan Information om kända fel och förändringar. Informationen publiceras med minst den framförhållning som specificeras i tabell 3.
2. Anslutande aktörer kan, inom 30 dagar från att informationen om kommande ändring har publicerats, återkoppla till servicedesk@ehalsomyndigheten.se om något hinder med den kommande ändringen har identifierats. 
3. Berörda värdemängder uppdateras.
4. Uppdaterade värdemängder tas i bruk, det vill säga, koderna börjar nyttjas i den Nationella läkemedelslistan.

För att en ändring ska anses ha liten påverkan kan följande ändringar ske i värdemängden.

• Ny kod
• Borttag av kod
• Ändring av användarvänlig text

En kod ska normalt sett aldrig byta definition och om det sker kommer det sannolikt innebära att ändringen hanteras som en stor påverkan. Att förtydliga den användarvänliga texten utan att ändra dess betydelse kan ske i alla värdemängder även de som är klassificerade med SP.

Information om kommande ändringar i värdemängder kommuniceras på sidan om Information om kända fel och förändringar.

Figur 2 - Rutin för värdemängder som ändras vid release

KRAV

Krav-ID: HK 3.2 (ersätter 34:1:1 del 3)

Uppdatering av mellanlagrade värdemängder, enligt tabell 4, ska ske innan den ändrade värdemängden tas i bruk.

Tabell 4 - Framförhållning vid uppdatering av releasebundna värdemängder.

2.4. Tidigare krav i TA 34

Kraven i TA 34 har utgått och ersatts av kraven på den här sidan samt nya generella presentationskrav.

Tabell 5 - Tidigare krav i TA 34.

Versionshistorik