Hantering av kodverk

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:

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.

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)

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)

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)

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.

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.

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. 

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.

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.

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

Värdemängd

Värdemängds-ID

Kommentar

Administreringsmetod

nll-snomed-method


Administreringsställe

nll-snomed-site


Administreringsväg

nll-snomed-route


Behandlingsorsak

nll-snomed-behandlingsorsak

Observera att det inte ges någon information om kommande uppdateringar i värdemängden, eftersom innehållet uppdateras och förvaltas av Socialstyrelsen.

Dosenhet

nll-ucum-unit


Doseringshastighetsenhetnll-ucum-rate-unit
Felregistreringsorsaknll-reason-for-cancellation
Händelseorsaknll-reason-for-provenance

Medicinteknisk produkt vid läkemedelsadministrering

nll-snomed-medical-device


Period på dygnetnll-event-timing

Precisering av administreringsställe

nll-snomed-qualifier


Ändringsorsaknll-snomed-reason-for-change


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.

Värdemängd

Värdemängds-ID

Kommentar

EDQM Administreringsmetod

nll-edqm-method


EDQM Administreringsväg

nll-edqm-route


MPAID Läkemedelsform

nll-mpa-form

Observera att det inte ges någon information om kommande uppdateringar i värdemängden.

Snomed CT Dosenhet

nll-snomed-unit


Snomed CT Doseringshastighetsenhet

nll-snomed-rate-unit


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

KodrelationKodrelations-IDKommentar
Administreringsställe till Precisering av administreringsställenll-site-to-qualifier
Administreringsväg till Administreringsställenll-route-to-site
Dosenhet till Snomed CT Dosenhetnll-ucum-unit-to-snomed
Doseringshastighetsenhet till Snomed CT Doseringshastighetsenhetnll-ucum-rate-unit-to-snomed
EDQM Administreringsmetod till Administreringsmetodnll-edqm-method-to-snomed

EDQM Administreringsväg till Administreringsväg

nll-edqm-route-to-snomed


Läkemedelsform till Dosenhet

nll-form-to-ucum-unit

Snomed CT Dosenhet till Dosenhet

nll-snomed-unit-to-ucum


Snomed CT Doseringshastighetsenhet till Doseringshastighetsenhetnll-snomed-rate-unit-to-ucum

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äkemedleslistan 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.

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.

VärdemängdVärdemängds-IDRegler för förändring
Absolut expedieringsintervallsenhetdispense-interval-unitsLP, framförhållning 6 mån.
Adresstypaddress-typesSP
AFF-felkodaff-codesLP, framförhållning 1 mån.
Aktuellt formatprescription-formatsSP
Allvarlighetsgrad på DetectedIssuedetected-issue-severitySP
Arbetsplats-id typworkplace-id-typesLP, framförhållning 3 mån.
Arbetsplatstypworkplace-typesLP, framförhållning 3 mån.
Beslut slutexpedieringcomplete-prescription-choicesSP
Bytes ejsubstitution-opposition-typesSP
Doseringstypdosage-typesSP
Dossamtyckestatusmulti-dose-disp-consent-statusSP
Dosunderlagsstatusmulti-dose-disp-basis-statusSP
Ekvivalensnll-concept-map-equivalenceLP, framförhållning 12 mån.
Enhet för administreringstillfällets varaktighetdose-duration-unitsLP, framförhållning 12 mån.
Felkoder FHIRfhir-error-codesLP, framförhållning 1 mån.
Folkbokfördpopulation-registered-statusLP, framförhållning 3 mån.
Förmånsvalbenefit-choicesLP, framförhållning 6 mån.
Förskrivning akutflaggamedication-request-prioritySP
Förskrivningsrättprescriptive-authority-codesLP, se information VARA.
Förskrivningsstatusmedication-request-statusSP
Förskrivningsstatusorsakmedication-request-status-reasonsLP, framförhållning 12 mån.
GruppförskrivarkodgruppforskrivarkodLP, framförhållning 3 mån.
HTTP-metodtransaction-operationsSP
HTTP-metoddispatch-operationsLP, framförhållning 1 mån.
Händelsetypprovenance-activity-typesLP, framförhållning 6 mån.
Händelsetyper för dossamtyckemultidosedispconsent-activity-typesLP, framförhållning 6 mån.
Händelsetyper för dosunderlagmultidosedispensingbasis-activity-typesLP, framförhållning 6 mån.
Händelsetyper för förskrivningarmedication-request-activity-typesLP, framförhållning 6 mån.
Händelsetyper för uttagmedication-dispense-activity-typesLP, framförhållning 6 mån.
Händelsetyper för åtkomstsamtyckeaccessconsent-activity-typesLP, framförhållning 6 mån.
Itereringprescription-iteration-typesLP, framförhållning 6 mån.
Könadministrative-genderLP, framförhållning 3 mån.
Längdenhet doseringsstegsequence-length-unitsLP, framförhållning 12 mån.
Narkotikaklassnarcotic-classificationLP, se information VARA.
Periodenhetdose-period-unitsLP, framförhållning 12 mån.
Produkttypproduct-typesLP, se information VARA.
Samtyckestypconsent-category-codesLP, framförhållning 1 mån.
Undantag: Borttag av kod är en SP.
Sorteringsordningprescription-sort-ordersLP, framförhållning 1 mån.
Spärrad uppgiftlocked-subjectsSP
Spärrhändelsetypdl-activity-typesLP, framförhållning 6 mån.
Spärrstatusdata-lock-statusLP, framförhållning 12 mån.
Spärrtypdata-lock-typesLP, framförhållning 12 mån.
Status för DetetectIssuedetected-issue-statusSP
Säkerhetsklassningsecurity-labelsLP, framförhållning 1 mån.
Telefonnummer tillhörcontactpoint-typesSP
Tilltalsnamnsmarkeringname-part-qualifierLP, framförhållning 12 mån.
Typ av aktörprovenance-participant-typesLP, framförhållning 6 mån.
Typ av Bundledispatch-bundle-typesLP, framförhållning 1 mån.
Undantag: Borttag av kod är en SP.
Typ av Bundletransaction-bundle-typesLP, framförhållning 1 mån.
Undantag: Borttag av kod är en SP.
Typ av förskrivningsnoteringmedreq-note-typesSP
Typ av registreringsunderlagregistration-basisLP, framförhållning 3 mån.
Typ av relationrelationship-typesSP
Typ av resursbasic-resource-typesLP, framförhållning 1 mån.
Undantag: Borttag av kod är en SP.
Typ av termnll-designation-useLP, framförhållning 6 mån
Utlämnandebegränsningdispensing-restrictionsLP, se information VARA.
Uttagsstatusmedication-dispense-statusSP
Uttagstypdispense-typesSP
Utökad yrkeskodnll-utokad-yrkeskodLP, framförhållning 6 mån
Yrkeskodnll-hosp-yrkeskodLP, framförhållning 6 mån
Åtkomstsamtyckestatusaccess-consent-statusSP
Åtkomsttypaccess-typesLP, framförhållning 1 mån.
Ändamålpurpose-typesLP, framförhållning 1 mån.

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.

Krav-IDKravKommentar

34:1:1 del 1

Anslutande system ska använda senaste versionen av Nationella läkemedelslistans värdemängder.Kravet har ersatts av HK 3.1 och 3.2 i kombination med övriga krav men finns kvar som delfunktion 1.
34:1:1 del 2Anslutande system ska läsa in information om värdemängder enligt tabell 2 från Nationella läkemedelslistan minst en gång per dygn.

Kravet har ersatts av HK 3.1 i kombination med övriga krav.

Tabell 2 i kravet listar de värdemängder som ändras fortlöpande.

34:1:1 del 3Övriga värdemängder i Nationella läkemedelslistan, det vill säga de som inte är listade ovan, uppdateras vid behov i samband med E-hälsomyndighetens releaser. Observera krav TK 10 och TK 11 i Krav på anropsresultat och felhantering.Kravet har ersatts av HK 3.2 i kombination med övriga krav.
34:2:1Om anslutande system nyttjar denna delfunktion för att hämta kodrelationer så ska information läsas in minst en gång per dygn.Kravet har ersatts av HK 3.1 i kombination med övriga krav men finns kvar som delfunktion 2.
34:3:1Denna delfunktion kan användas för att läsa in historiska versioner av en specifik värdemängd från Nationella läkemedelslistan. "Kravet" har utgått men finns kvar som delfunktion 3.
34:4:1Denna delfunktion kan användas för att anslutande system ska kunna kontrollera om en kod är aktiv i angiven värdemängd ... eller hitta en användarvänlig text till en inaktiv kod."Kravet" har utgått men finns kvar som delfunktion 4.
34:5:1Denna 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."Kravet" har utgått men finns kvar som delfunktion 5.
34:P.1

Vid presentation ska klartext som beskriver en kods innebörd visas för användare.

Kravet är flyttat till Generella presentationskrav med den nya kravbeteckningen P30.
34:P.2

Tidigare skrivning: "När det i en befintlig förskrivning förekommer en kod som har utgått ska klartexten fortsatt vara tillgänglig för användaren."

Ny skrivning: "När det förekommer en kod som har inaktiverats i en befintlig informationsresurs ska klartexten till den utgångna koden visas för användaren"

Kravet är flyttat till Generella presentationskrav med den nya kravbeteckningen P31. Kravet har förtydligats.
34:P.3

Tidigare skrivning: "Samtliga förekommande termer i följande kodverk/värdemängder ska kunna visas för användaren och registreras i olika tillämpningar ..."

Ny skrivning: "Samtliga begrepp som förekommer i de värdemängder som används i det anslutande systemet ska vara tillgängliga för användaren om inget annat framgår av verksamhetsflöden och tillämpningsfall"

Kravet är flyttat till Generella presentationskrav med den nya kravbeteckningen P32. Kravet har förtydligats.



Versionshistorik

VersionDatumKommentar
1.02023-11-09Ny sida
1.12023-11-24Värdemängden Ekvivalens saknades i tabell 4
1.22024-03-19

Förtydligande  under avsnitt Uppdatering av värdemängder som ändras vid release:

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.