ValueSet (ValueSet)
Übersicht aller verbindlicher ValueSet-Bindings in diesem Modul
Übersicht aller flexibler ValueSet-Bindings
Pfad | Staerke | ValueSet |
---|---|---|
Extension.extension:Entlassform.value[x] | extensible | https://gematik.de/fhir/isik/ValueSet/ISiKEntlassformReha |
Encounter.hospitalization.admitSource | extensible | http://fhir.de/ValueSet/dgkev/Aufnahmeanlass |
Encounter.location.physicalType | extensible | https://gematik.de/fhir/isik/ValueSet/ISiKLocationPhysicalType |
Procedure.category.coding:SNOMED-CT | preferred | https://gematik.de/fhir/isik/ValueSet/ProzedurenKategorieSCT |
ISiKValueSet
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
Canonical | https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet |
---|---|
Status | active |
Version | 4.0.1 |
Basis | http://hl7.org/fhir/StructureDefinition/ValueSet |
Inhalt
ISiKValueSet (ValueSet) | I | ValueSet | |
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 | S Σ | 1..* | UsageContext |
id | 0..1 | string | |
extension | I | 0..* | Extension |
code | Σ | 1..1 | CodingBindingPattern |
value[x] | Σ | 1..1 | Binding |
valueCodeableConcept | CodeableConcept | ||
jurisdiction | Σ | 0..* | CodeableConceptBinding |
immutable | Σ | 0..1 | boolean |
purpose | 0..1 | markdown | |
copyright | 0..1 | markdown | |
compose | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
lockedDate | Σ | 0..1 | date |
inactive | Σ | 0..1 | boolean |
include | Σ I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
system | Σ I | 0..1 | uri |
version | Σ | 0..1 | string |
concept | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | 1..1 | code | |
display | 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 | |
filter | Σ I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
property | Σ | 1..1 | code |
op | Σ | 1..1 | codeBinding |
value | Σ | 1..1 | string |
valueSet | Σ I | 0..* | canonical(ValueSet) |
exclude | I | 0..* | see (include) |
expansion | S | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
identifier | 0..1 | uri | |
timestamp | S | 1..1 | dateTime |
total | 0..1 | integer | |
offset | 0..1 | integer | |
parameter | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | 1..1 | string | |
value[x] | 0..1 | ||
valueString | string | ||
valueBoolean | boolean | ||
valueInteger | integer | ||
valueDecimal | decimal | ||
valueUri | uri | ||
valueCode | code | ||
valueDateTime | dateTime | ||
contains | S I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
system | S | 1..1 | uri |
abstract | 0..1 | boolean | |
inactive | 0..1 | boolean | |
version | S | 1..1 | string |
code | S I | 1..1 | code |
display | S I | 1..1 | string |
designation | 0..* | see (designation) | |
contains | 0..* | 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ü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 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 Änderung des dazugehörigen CodeSystems MUSS eine Ä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ü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="ValueSet.useContext"> <path value="ValueSet.useContext" /> <comment value="**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 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
Interaktionen
Interaktion | Verbindlichkeit |
---|---|
read | SHALL |
search-type | SHALL |
Parameter | Typ | Verbindlichkeit | Hinweise |
---|---|---|---|
_id | token | SHALL | Beispiel: |
_tag | token | SHALL | Beispiel: |
_count | number | SHALL | Beispiel: |
_has | string | MAY | Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben |
url | uri | SHALL | Beispiel: |
name | string | SHALL | Beispiel: |
status | token | SHALL | Beispiel: |
version | token | SHALL | Beispiel: |
context-type-value | composite | MAY | Beispiel: |
(Reverse-)Include
Anmerkungen zu Must-Support-Feldern
Feldname | Kurzbeschreibung | Hinweise |
---|---|---|
ValueSet.url | Bedeutung: Eindeutige Url zur Identifizierung des ValueSets. Absolute Urls sind zu bevorzugen. Hinweise: OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE eine Canonical Url vergeben werden. | |
ValueSet.version | Bedeutung: Version des ValueSets Hinweise: Jede Änderung des dazugehörigen CodeSystems MUSS eine Änderung in der Version des CodeSystems und ValueSets nach sich ziehen. | |
ValueSet.name | Bedeutung: Maschinenlesbarer Name des ValueSets Hinweise: Der Constraint vsd-0 ist hierbei zu beachten. | |
ValueSet.status | Status | Zeigt den aktuellen Status der Ressource an.
|
ValueSet.useContext | Bedeutung: Angabe für welches Datenelement das ValueSet relevant ist 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. | |
ValueSet.expansion | Bedeutung: Angabe der Konzepte aus denen sich das ValueSet zusammensetzt. Hinweise: Mindestens MUSS ein Code und ein Anzeigetext spezifiziert werden. | |
ValueSet.expansion.timestamp | ||
ValueSet.expansion.contains | ||
ValueSet.expansion.contains.system | ||
ValueSet.expansion.contains.version | ||
ValueSet.expansion.contains.code | ||
ValueSet.expansion.contains.display |
Valides Minimalbeispiel:
ValueSet 'TestValueSet'
Version | 2.0.2 |
Status | Active |
Use Context
- focus: Encounter
Expansion
This expansion was generated on 2022-03-30
Code | System | Display |
---|---|---|
test | http://example.org/fhir/CodeSystem/TestKatalog | Test |
<ValueSet xmlns="http://hl7.org/fhir"> <id value="ISiKValueSetExample" /> <meta> <profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet" /> </meta> <url value="http://example.org/fhir/ValueSet/TestValueSet" /> <version value="2.0.2" /> <name value="TestValueSet" /> <status value="active" /> <useContext> <code> <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" /> <code value="focus" /> </code> <valueCodeableConcept> <coding> <system value="http://hl7.org/fhir/resource-types" /> <code value="Encounter" /> </coding> </valueCodeableConcept> </useContext> <expansion> <timestamp value="2022-03-30" /> <contains> <system value="http://example.org/fhir/CodeSystem/TestKatalog" /> <version value="1.0.0" /> <code value="test" /> <display value="Test" /> </contains> </expansion> </ValueSet>
{ "resourceType": "ValueSet", "id": "ISiKValueSetExample", "meta": { "profile": [ "https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet" ] }, "useContext": [ { "code": { "code": "focus", "system": "http://terminology.hl7.org/CodeSystem/usage-context-type" }, "valueCodeableConcept": { "coding": [ { "code": "Encounter", "system": "http://hl7.org/fhir/resource-types" } ] } } ], "url": "http://example.org/fhir/ValueSet/TestValueSet", "version": "2.0.2", "name": "TestValueSet", "status": "active", "expansion": { "timestamp": "2022-03-30", "contains": [ { "system": "http://example.org/fhir/CodeSystem/TestKatalog", "version": "1.0.0", "code": "test", "display": "Test" } ] } }