ValueSet (ValueSet)


Motivation

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


Kompatibilität

Zum Zeitpunkt der Veröffentlichung waren keine weiteren Profile in nationalen Spezifikationen für dieses Datenobjekt bekannt.

FHIR-Profil

NameCanonical
ISiKValueSethttps://gematik.de/fhir/isik/v2/Basismodul/StructureDefinition/ISiKValueSet
idS Σ1..1System.String
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
codeΣ1..1CodingBinding
valueCodeableConceptCodeableConcept
jurisdictionΣ0..*CodeableConceptBinding
immutableΣ0..1boolean
purpose0..1markdown
copyright0..1markdown
lockedDateΣ0..1date
inactiveΣ0..1boolean
systemΣ I0..1uri
versionΣ0..1string
code1..1code
display0..1string
language0..1codeBinding
use0..1CodingBinding
value1..1string
propertyΣ1..1code
opΣ1..1codeBinding
valueΣ1..1string
valueSetΣ I0..*canonical(ValueSet)
excludeI0..*see (include)
identifier0..1uri
timestampS1..1dateTime
total0..1integer
offset0..1integer
name1..1string
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueDecimaldecimal
valueUriuri
valueCodecode
valueDateTimedateTime
systemS1..1uri
abstract0..1boolean
inactive0..1boolean
versionS1..1string
codeS I1..1code
displayS I1..1string
designation0..*see (designation)
contains0..*see (contains)

Anmerkungen zu Must-Support-Feldern

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

Bedeutung: Indikation, ob das ValueSet 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.

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.


Interaktionen

Für die Ressource ValueSet MUSS die REST-Interaktion "READ" implementiert werden.

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

  1. Der Suchparameter "_id" MUSS unterstützt werden:

    Beispiele:

    GET [base]/ValueSet?_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:

    Beispiele:

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

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

  3. Der Suchparameter "name" MUSS unterstützt werden:

    Beispiele:

    GET [base]/ValueSet?name=TestValueSet

    Anwendungshinweise: Weitere Informationen zur Suche nach "ValueSet.name" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".

  4. Der Suchparameter "status" MUSS unterstützt werden:

    Beispiele:

    GET [base]/ValueSet?status=active

    Anwendungshinweise: Weitere Informationen zur Suche nach "ValueSet.status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search"".

  5. Der Suchparameter "version" MUSS unterstützt werden:

    Beispiele:

    GET [base]/ValueSet?version=1.0.0

    Anwendungshinweise: Weitere Informationen zur Suche nach "ValueSet.version" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

  6. Der Suchparameter "context-type-value" MUSS unterstützt werden:

    Beispiele:

    GET [base]/ValueSet?context-type-value=http://terminology.hl7.org/CodeSystem/usage-context-type|focus$http://hl7.org/fhir/resource-types|Encounter

    Anwendungshinweise: Weitere Informationen zur Suche nach "CodeSystem.useContext" finden sich in der FHIR-Basisspezifikation - Abschnitt "Composite Search Parameters".


Beispiele

Valides Minimalbeispiel Patient:

{
    "resourceType": "ValueSet",
    "id": "ISiKValueSetExample",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/isik/v2/Basismodul/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"
            }
        ]
    }
}