Katalog (CodeSystem)


Motivation

Katalog

ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/Systeminterne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Displaywerte.

Eine maschinenlesbare Repräsentation dieser Kodierungen erlaubt es Clients dazugehörige Anzeigetext und Definitionen zu verarbeiten.

Ein Codesystem eignet sich auch dazu, auf dessen Basis definierte ValueSets zu expandieren. Da ISiKValueSet expandierte Valuesets vorsieht, ist eine dynamische Expansion in der Regel nicht erforderlich. Darüber hinausgehend ist ein Use Case im Kontext der Katalogabfrage folgender: Ein Client möchte eine Expansion neu generieren (z.B. mit anderen Expansionen-Parametern), um das ValueSet beispielsweise in einer anderen Sprache auszugeben.

Normativer Status und Bestätigung

Dieses Profil MUSS im Rahmen der Bestätigung NICHT unterstützt werden. Falls das Profil unterstützt werden soll, MÜSSEN die hier definierten Festlegungen greifen (auch im Bestätigungsverfahren).


FHIR-Profil

NameCanonical
ISiKCodeSystemhttps://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKCodeSystem
idS Σ1..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlS Σ1..1uri
identifierΣ0..*Identifier
versionS Σ1..1string
nameS Σ I1..1string
titleΣ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
description0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
caseSensitiveΣ0..1boolean
valueSetΣ0..1canonical(ValueSet)
hierarchyMeaningΣ0..1codeBinding
compositionalΣ0..1boolean
versionNeededΣ0..1boolean
contentS Σ1..1codeBinding
supplementsΣ0..1canonical(CodeSystem)
countΣ0..1unsignedInt
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1code
descriptionΣ0..1string
operatorΣ1..*codeBinding
valueΣ1..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1code
uriΣ0..1uri
descriptionΣ0..1string
typeΣ1..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS1..1code
displayS1..1string
definitionS0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language0..1codeBinding
use0..1CodingBinding
value1..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1code
valueCodecode
valueCodingCoding
valueStringstring
valueIntegerinteger
valueBooleanboolean
valueDateTimedateTime
valueDecimaldecimal
concept0..*see (concept)

Interaktionen

Für die Ressource CodeSystem MUSS die REST-Interaktion "READ" implementiert werden, falls die Resource CodeSystem umgesetzt wird.

Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:

  1. Der Suchparameter "_id" MUSS unterstützt werden, falls die Resource CodeSystem umgesetzt wird:

    Beispiele:

    GET [base]/CodeSystem?_id=103270

    Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".

  2. Der Suchparameter "url" MUSS unterstützt werden, falls die Resource CodeSystem umgesetzt wird:

    Beispiele:

    GET [base]/CodeSystem?url=http://example.org/fhir/CodeSystem/test

    Anwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.url" finden sich in der FHIR-Basisspezifikation - Abschnitt "uri".


Anmerkungen zu Must-Support-Feldern

CodeSystem.url

Bedeutung: Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen.

Hinweise: OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE ein Canonical Url vergeben werden.

CodeSystem.version

Bedeutung: Version des CodeSystems

Hinweise: Jede Änderung des CodeSystems MUSS eine Änderung in der Version des CodeSystems und gebundenen ValueSets nach sich ziehen. Die Versionierung SOLLTE auf Basis von Semantic Versioning basieren.

CodeSystem.name

Bedeutung: Maschinenlesbarer Name des CodeSystems

Hinweise: Der Constraint cps-0 ist hierbei zu beachten.

CodeSystem.status

Bedeutung: Indikation, ob das CodeSystem in aktiver Verwendung ist.

Hinweise: Alle in einem System möglichen Status-Werte MÜSSEN über FHIR korrekt repräsentiert werden. KÖNNEN mindestens jedoch die Status-Werte "active" und "retired". Deren korrekte Abbildung wird im Rahmen des Bestätigungsverfahrens überprüft.

CodeSystem.content

Bedeutung: Angabe, ob es sich um eine vollständige Repräsentation des CodeSystems oder nur um einen Auszug handelt.

Hinweise: Alle in einem System möglichen Status-Werte müssen über FHIR korrekt repräsentiert werden können, mindestens jedoch die Status-Werte "fragment" und "complete". Deren korrekte Abbildung wird im Rahmen des Bestätigungsverfahrens überprüft.

CodeSystem.concept

Bedeutung: Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt.

Hinweise: Es MUSS mindestens ein Code und ein Anzeigetext spezifiziert werden.


Beispiele

Valides Minimalbeispiel CodeSystem:

{
    "resourceType": "CodeSystem",
    "id": "CodeSystemExample",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKCodeSystem"
        ]
    },
    "url": "http://example.org/fhir/CodeSystem/TestKatalog",
    "version": "2.0.2",
    "name": "TestKatalog",
    "status": "active",
    "content": "complete",
    "concept":  [
        {
            "code": "test",
            "display": "Test",
            "definition": "Dies ist ein Test-Code"
        }
    ]
}