Dieses Profil beschreibt die maschinenlesbare Auswahl von Codes für die Kodierung spezifischer FHIR-Elemente in ISiK-Szenarien.

Motivation

ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus- / System-interne Kodierungen. Mittels der Veröffentlichung von ValueSets können Auswahllisten für externe Clients bereitgestellt werden, sodass diese entsprechende Kodierungen ebenfalls anbieten können.

Kompatibilität

Für das Profil ISiKValueSet wurde bis zum Zeitpunkt der Veröffentlichung kein Abgleich der Kompatibilität zu anderen Profilen (der KBV und der Medizininformatik-Initiative) durchgeführt. Hinweise zu Inkompatibilitäten können über die Portalseite gemeldet werden.

Bestätigungsrelevanz

Metadaten

Canonicalhttps://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet
Statusactive
Version4.0.1
Basishttp://hl7.org/fhir/StructureDefinition/ValueSet

Inhalt

idΣ0..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
id0..1string
extensionI0..*Extension
codeΣ1..1CodingBindingPattern
valueCodeableConceptCodeableConcept
jurisdictionΣ0..*CodeableConceptBinding
immutableΣ0..1boolean
purpose0..1markdown
copyright0..1markdown
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lockedDateΣ0..1date
inactiveΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
systemΣ I0..1uri
versionΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1code
display0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language0..1codeBinding
use0..1CodingBinding
value1..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
propertyΣ1..1code
opΣ1..1codeBinding
valueΣ1..1string
valueSetΣ I0..*canonical(ValueSet)
excludeI0..*see (include)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..1uri
timestampS1..1dateTime
total0..1integer
offset0..1integer
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
name1..1string
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueDecimaldecimal
valueUriuri
valueCodecode
valueDateTimedateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
systemS1..1uri
abstract0..1boolean
inactive0..1boolean
versionS1..1string
codeS I1..1code
displayS I1..1string
designation0..*see (designation)
contains0..*see (contains)
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ISiKValueSet" />
    <url value="https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet" />
    <version value="4.0.1" />
    <name value="ISiKValueSet" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-11-25" />
    <publisher value="gematik GmbH" />
    <description value="Dieses Profil beschreibt die maschinenlesbare Auswahl von Codes \nf&#252;r die Kodierung spezifischer FHIR-Elemente in ISiK-Szenarien.\n### Motivation\n\nISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus- / System-interne Kodierungen.\nMittels der Ver&#246;ffentlichung von ValueSets k&#246;nnen Auswahllisten f&#252;r externe Clients bereitgestellt werden, sodass diese entsprechende Kodierungen ebenfalls anbieten k&#246;nnen.\n### Kompatibilit&#228;t\n\nF&#252;r das Profil ISiKValueSet wurde bis zum Zeitpunkt der Ver&#246;ffentlichung kein Abgleich der Kompatibilit&#228;t zu anderen Profilen (der KBV und der Medizininformatik-Initiative) durchgef&#252;hrt.\nHinweise zu Inkompatibilit&#228;ten k&#246;nnen &#252;ber die [Portalseite](https://service.gematik.de/servicedesk/customer/portal/16) gemeldet werden." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ValueSet" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ValueSet" />
    <derivation value="constraint" />
    <differential>
        <element id="ValueSet.url">
            <path value="ValueSet.url" />
            <comment value="**Bedeutung:** Eindeutige Url zur Identifizierung des ValueSets. Absolute Urls sind zu bevorzugen.\n\n**Hinweise:** OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE eine Canonical Url vergeben werden." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.version">
            <path value="ValueSet.version" />
            <comment value="**Bedeutung:** Version des ValueSets\n\n**Hinweise:** Jede &#196;nderung des dazugeh&#246;rigen CodeSystems MUSS eine &#196;nderung in der Version des CodeSystems und ValueSets nach sich ziehen." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.name">
            <path value="ValueSet.name" />
            <comment value="**Bedeutung:** Maschinenlesbarer Name des ValueSets\n\n**Hinweise:** Der Constraint [vsd-0](https://www.hl7.org/fhir/R4/valueset.html#invs) ist hierbei zu beachten." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.status">
            <path value="ValueSet.status" />
            <short value="Status" />
            <comment value="Zeigt den aktuellen Status der Ressource an.     \n  **WICHTIGER Hinweis f&#252;r Implementierer:**    \n  * Alle server-seitigen Implementierungen M&#220;SSEN in der Lage sein, \n  die systemintern m&#246;glichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch &#39;active&#39; und &#39;retired&#39;&#39;.\n  * Alle client-seitigen Implementierungen M&#220;SSEN in der Lage sein, s&#228;mtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu k&#246;nnen, \n  beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben." />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.useContext">
            <path value="ValueSet.useContext" />
            <comment value="**Bedeutung:** Angabe f&#252;r welches Datenelement das ValueSet relevant ist\n\n**Hinweise:** Es muss mindestens ein useContext angegeben werden, in dem der Ressourcen-Typ kodiert wird, in dem das ValueSet in einem Element zur Verwendung kommt." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.useContext.code">
            <path value="ValueSet.useContext.code" />
            <patternCoding>
                <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
                <code value="focus" />
            </patternCoding>
        </element>
        <element id="ValueSet.useContext.value[x]">
            <path value="ValueSet.useContext.value[x]" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="required" />
                <description value="One of the resource types defined as part of this version of FHIR." />
                <valueSet value="http://hl7.org/fhir/ValueSet/resource-types" />
            </binding>
        </element>
        <element id="ValueSet.expansion">
            <path value="ValueSet.expansion" />
            <comment value="**Bedeutung:** Angabe der Konzepte aus denen sich das ValueSet zusammensetzt.\n\n**Hinweise:** Mindestens MUSS ein Code und ein Anzeigetext spezifiziert werden." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.timestamp">
            <path value="ValueSet.expansion.timestamp" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.contains">
            <path value="ValueSet.expansion.contains" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.contains.system">
            <path value="ValueSet.expansion.contains.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.contains.version">
            <path value="ValueSet.expansion.contains.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.contains.code">
            <path value="ValueSet.expansion.contains.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.expansion.contains.display">
            <path value="ValueSet.expansion.contains.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "ISiKValueSet",
    "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet",
    "version": "4.0.1",
    "name": "ISiKValueSet",
    "status": "active",
    "experimental": false,
    "date": "2024-11-25",
    "publisher": "gematik GmbH",
    "description": "Dieses Profil beschreibt die maschinenlesbare Auswahl von Codes \nfür die Kodierung spezifischer FHIR-Elemente in ISiK-Szenarien.\n### Motivation\n\nISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus- / System-interne Kodierungen.\nMittels der Veröffentlichung von ValueSets können Auswahllisten für externe Clients bereitgestellt werden, sodass diese entsprechende Kodierungen ebenfalls anbieten können.\n### Kompatibilität\n\nFür das Profil ISiKValueSet wurde bis zum Zeitpunkt der Veröffentlichung kein Abgleich der Kompatibilität zu anderen Profilen (der KBV und der Medizininformatik-Initiative) durchgeführt.\nHinweise zu Inkompatibilitäten können über die [Portalseite](https://service.gematik.de/servicedesk/customer/portal/16) gemeldet werden.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ValueSet",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ValueSet",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ValueSet.url",
                "path": "ValueSet.url",
                "short": "",
                "comment": "**Bedeutung:** Eindeutige Url zur Identifizierung des ValueSets. Absolute Urls sind zu bevorzugen.\n\n**Hinweise:** OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE eine Canonical Url vergeben werden.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.version",
                "path": "ValueSet.version",
                "short": "",
                "comment": "\n**Bedeutung:** Version des ValueSets\n\n**Hinweise:** Jede Änderung des dazugehörigen CodeSystems MUSS eine Änderung in der Version des CodeSystems und ValueSets nach sich ziehen.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.name",
                "path": "ValueSet.name",
                "short": "",
                "comment": "**Bedeutung:** Maschinenlesbarer Name des ValueSets\n\n**Hinweise:** Der Constraint [vsd-0](https://www.hl7.org/fhir/R4/valueset.html#invs) ist hierbei zu beachten.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.status",
                "path": "ValueSet.status",
                "short": "Status",
                "comment": "Zeigt den aktuellen Status der Ressource an.     \n  **WICHTIGER Hinweis für Implementierer:**    \n  * Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, \n  die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch 'active' und 'retired''.\n  * Alle client-seitigen Implementierungen MÜSSEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können, \n  beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.",
                "mustSupport": true
            },
            {
                "id": "ValueSet.useContext",
                "path": "ValueSet.useContext",
                "short": "",
                "comment": "**Bedeutung:** Angabe für welches Datenelement das ValueSet relevant ist\n\n**Hinweise:** Es muss mindestens ein useContext angegeben werden, in dem der Ressourcen-Typ kodiert wird, in dem das ValueSet in einem Element zur Verwendung kommt.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.useContext.code",
                "path": "ValueSet.useContext.code",
                "short": "",
                "comment": "",
                "patternCoding": {
                    "code": "focus",
                    "system": "http://terminology.hl7.org/CodeSystem/usage-context-type"
                }
            },
            {
                "id": "ValueSet.useContext.value[x]",
                "path": "ValueSet.useContext.value[x]",
                "short": "",
                "comment": "",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
                    "description": "One of the resource types defined as part of this version of FHIR."
                }
            },
            {
                "id": "ValueSet.expansion",
                "path": "ValueSet.expansion",
                "short": "",
                "comment": "**Bedeutung:** Angabe der Konzepte aus denen sich das ValueSet zusammensetzt.\n\n**Hinweise:** Mindestens MUSS ein Code und ein Anzeigetext spezifiziert werden.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.timestamp",
                "path": "ValueSet.expansion.timestamp",
                "short": "",
                "comment": "",
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.contains",
                "path": "ValueSet.expansion.contains",
                "short": "",
                "comment": "",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.contains.system",
                "path": "ValueSet.expansion.contains.system",
                "short": "",
                "comment": "",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.contains.version",
                "path": "ValueSet.expansion.contains.version",
                "short": "",
                "comment": "",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.contains.code",
                "path": "ValueSet.expansion.contains.code",
                "short": "",
                "comment": "",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "ValueSet.expansion.contains.display",
                "path": "ValueSet.expansion.contains.display",
                "short": "",
                "comment": "",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Constraints/Invarianten