ISiKCodeSystem
Dieses Profil beschreibt die maschinenlesbare Repräsentation von system-spezifischen Kodierungen in ISiK-Szenarien.
Motivation
ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/System-interne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Display-Werte.
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.
Bestätigungsrelevanz
Verbindlichkeit | MAY |
---|
Metadaten
Canonical | https://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystem |
---|---|
Status | active |
Version | 4.0.1 |
Basis | http://hl7.org/fhir/StructureDefinition/CodeSystem |
Inhalt
ISiKCodeSystem (CodeSystem) | I | CodeSystem | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
url | S Σ | 1..1 | uri |
identifier | Σ | 0..* | Identifier |
version | S Σ | 1..1 | string |
name | S Σ I | 1..1 | string |
title | Σ | 0..1 | string |
status | S Σ ?! | 1..1 | codeBinding |
experimental | Σ | 0..1 | boolean |
date | Σ | 0..1 | dateTime |
publisher | Σ | 0..1 | string |
contact | Σ | 0..* | ContactDetail |
description | 0..1 | markdown | |
useContext | Σ | 0..* | UsageContext |
jurisdiction | Σ | 0..* | CodeableConceptBinding |
purpose | 0..1 | markdown | |
copyright | 0..1 | markdown | |
caseSensitive | Σ | 0..1 | boolean |
valueSet | Σ | 0..1 | canonical(ValueSet) |
hierarchyMeaning | Σ | 0..1 | codeBinding |
compositional | Σ | 0..1 | boolean |
versionNeeded | Σ | 0..1 | boolean |
content | S Σ | 1..1 | codeBinding |
supplements | Σ | 0..1 | canonical(CodeSystem) |
count | Σ | 0..1 | unsignedInt |
filter | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | code |
description | Σ | 0..1 | string |
operator | Σ | 1..* | codeBinding |
value | Σ | 1..1 | string |
property | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | code |
uri | Σ | 0..1 | uri |
description | Σ | 0..1 | string |
type | Σ | 1..1 | codeBinding |
concept | S | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | S | 1..1 | code |
display | S | 1..1 | string |
definition | S | 0..1 | string |
designation | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
language | 0..1 | codeBinding | |
use | 0..1 | CodingBinding | |
value | 1..1 | string | |
property | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | 1..1 | code | |
value[x] | 1..1 | ||
valueCode | code | ||
valueCoding | Coding | ||
valueString | string | ||
valueInteger | integer | ||
valueBoolean | boolean | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
concept | 0..* | see (concept) |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="ISiKCodeSystem" /> <url value="https://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystem" /> <version value="4.0.1" /> <name value="ISiKCodeSystem" /> <status value="active" /> <experimental value="false" /> <date value="2024-11-25" /> <publisher value="gematik GmbH" /> <description value="Dieses Profil beschreibt die maschinenlesbare Repräsentation von \nsystem-spezifischen Kodierungen in ISiK-Szenarien. \n\n### Motivation\n\nISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/System-interne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Display-Werte. \n\nEine maschinenlesbare Repräsentation dieser Kodierungen erlaubt es Clients, dazugehörige Anzeigetext und Definitionen zu verarbeiten.\n\nEin Codesystem eignet sich auch dazu, auf dessen Basis definierte [ValueSets zu expandieren](https://hl7.org/fhir/R4/valueset-operation-expand.html).\nDa ISiKValueSet expandierte Valuesets vorsieht, ist eine dynamische Expansion in der Regel nicht erforderlich.\nDarü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." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="CodeSystem" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CodeSystem" /> <derivation value="constraint" /> <differential> <element id="CodeSystem.url"> <path value="CodeSystem.url" /> <short value="Kanonische URL" /> <comment value="**Bedeutung:** Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen. \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="CodeSystem.version"> <path value="CodeSystem.version" /> <short value="Version" /> <comment value="**Bedeutung:** Version des CodeSystems \n **Hinweise:** Jede Änderung des CodeSystems MUSS eine Änderung in der Version des CodeSystems und gebundenen ValueSets nach sich ziehen. Die Versionierung SOLLTE auf dem Konzept von [Semantic Versioning](https://semver.org) basieren." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="CodeSystem.name"> <path value="CodeSystem.name" /> <short value="Name des Codesystems" /> <comment value="**Bedeutung:** Maschinenlesbarer Name des CodeSystems \n **Hinweise:** Der Constraint [cps-0](https://www.hl7.org/fhir/R4/codesystem.html#invs) ist hierbei zu beachten." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="CodeSystem.status"> <path value="CodeSystem.status" /> <short value="Status" /> <comment value="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 value="true" /> </element> <element id="CodeSystem.content"> <path value="CodeSystem.content" /> <short value="Vollständigkeit der Repräsentation" /> <comment value="**Bedeutung:** Angabe, ob es sich um eine vollständige Repräsentation des CodeSystems oder nur um einen Auszug handelt.\n **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." /> <mustSupport value="true" /> </element> <element id="CodeSystem.concept"> <path value="CodeSystem.concept" /> <comment value="**Bedeutung:** Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt. \n **Hinweise:** Es MUSS mindestens ein Code und ein Anzeigetext spezifiziert werden." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="CodeSystem.concept.code"> <path value="CodeSystem.concept.code" /> <mustSupport value="true" /> </element> <element id="CodeSystem.concept.display"> <path value="CodeSystem.concept.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="CodeSystem.concept.definition"> <path value="CodeSystem.concept.definition" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "ISiKCodeSystem", "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystem", "version": "4.0.1", "name": "ISiKCodeSystem", "status": "active", "experimental": false, "date": "2024-11-25", "publisher": "gematik GmbH", "description": "Dieses Profil beschreibt die maschinenlesbare Repräsentation von \nsystem-spezifischen Kodierungen in ISiK-Szenarien. \n\n### Motivation\n\nISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/System-interne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Display-Werte. \n\nEine maschinenlesbare Repräsentation dieser Kodierungen erlaubt es Clients, dazugehörige Anzeigetext und Definitionen zu verarbeiten.\n\nEin Codesystem eignet sich auch dazu, auf dessen Basis definierte [ValueSets zu expandieren](https://hl7.org/fhir/R4/valueset-operation-expand.html).\nDa ISiKValueSet expandierte Valuesets vorsieht, ist eine dynamische Expansion in der Regel nicht erforderlich.\nDarü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. ", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "CodeSystem", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CodeSystem", "derivation": "constraint", "differential": { "element": [ { "id": "CodeSystem.url", "path": "CodeSystem.url", "short": "Kanonische URL", "comment": "**Bedeutung:** Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen. \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": "CodeSystem.version", "path": "CodeSystem.version", "short": "Version", "comment": "**Bedeutung:** Version des CodeSystems \n **Hinweise:** Jede Änderung des CodeSystems MUSS eine Änderung in der Version des CodeSystems und gebundenen ValueSets nach sich ziehen. Die Versionierung SOLLTE auf dem Konzept von [Semantic Versioning](https://semver.org) basieren.", "min": 1, "mustSupport": true }, { "id": "CodeSystem.name", "path": "CodeSystem.name", "short": "Name des Codesystems", "comment": "**Bedeutung:** Maschinenlesbarer Name des CodeSystems \n **Hinweise:** Der Constraint [cps-0](https://www.hl7.org/fhir/R4/codesystem.html#invs) ist hierbei zu beachten.", "min": 1, "mustSupport": true }, { "id": "CodeSystem.status", "path": "CodeSystem.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": "CodeSystem.content", "path": "CodeSystem.content", "short": "Vollständigkeit der Repräsentation", "comment": "**Bedeutung:** Angabe, ob es sich um eine vollständige Repräsentation des CodeSystems oder nur um einen Auszug handelt.\n **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.", "mustSupport": true }, { "id": "CodeSystem.concept", "path": "CodeSystem.concept", "short": "", "comment": "**Bedeutung:** Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt. \n **Hinweise:** Es MUSS mindestens ein Code und ein Anzeigetext spezifiziert werden.", "min": 1, "mustSupport": true }, { "id": "CodeSystem.concept.code", "path": "CodeSystem.concept.code", "short": "", "comment": "", "mustSupport": true }, { "id": "CodeSystem.concept.display", "path": "CodeSystem.concept.display", "short": "", "comment": "", "min": 1, "mustSupport": true }, { "id": "CodeSystem.concept.definition", "path": "CodeSystem.concept.definition", "short": "", "comment": "", "mustSupport": true } ] } }