ISiK Basis Implementierungsleitfaden
Version 6.0.0-rc - ci-build

Resource Profile: ISiKValueSet

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Version des ValueSets
... name SΣC 1..1 string Name des ValueSets
... status ?!SΣ 1..1 code Status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... useContext SΣ 1..* UsageContext Datenelement-Relevanz das ValueSet
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains SC 1..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 1..1 uri System value for the code
..... version S 1..1 string Version in which this code/display is defined
..... code SC 1..1 code Code - if blank, this is not a selectable code
..... display SC 1..1 string User display for the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.useContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... url S 1..1 uri Eindeutige Url des ValueSets
... name S 1..1 string Name des ValueSets
... status S 1..1 code Status
... useContext S 1..* UsageContext Datenelement-Relevanz das ValueSet
.... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
.... value[x] 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains S 1..* BackboneElement Codes in the value set
..... system S 1..1 uri System value for the code
..... version S 1..1 string Version in which this code/display is defined
..... code S 1..1 code Code - if blank, this is not a selectable code
..... display S 1..1 string User display for the concept

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Eindeutige Url des ValueSets
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version SΣ 1..1 string Version des ValueSets
... name SΣC 1..1 string Name des ValueSets
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code Status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext SΣ 1..* UsageContext Datenelement-Relevanz das ValueSet
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains SC 1..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 1..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version S 1..1 string Version in which this code/display is defined
..... code SC 1..1 code Code - if blank, this is not a selectable code
..... display SC 1..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ValueSet.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.useContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()
ElementShort descriptionNotes
ValueSet.expansion Expansion der Konzepte

Bedeutung: Angabe der Konzepte aus denen sich das ValueSet zusammensetzt.

Hinweise: Mindestens MUSS ein Code und ein Anzeigetext spezifiziert werden.
ValueSet.expansion.contains

Enthält die Liste der Konzepte, die in der Expansion enthalten sind.
ValueSet.expansion.contains.code

Der spezifische Code des Konzepts im definierten Codingsystem.
ValueSet.expansion.contains.display

Die menschlich lesbare Darstellung des Konzepts.
ValueSet.expansion.contains.system

Gibt das Codingsystem an, aus dem das Konzept stammt.
ValueSet.expansion.contains.version

Spezifiziert die Version des Codingsystems, die verwendet wurde.
ValueSet.expansion.timestamp

Angabe zu welchem Zeitpunkt die Expansion generiert wurden ist.
ValueSet.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.
ValueSet.name Name des ValueSets

Bedeutung: Maschinenlesbarer Name des ValueSets

Hinweise: Der Constraint vsd-0 ist hierbei zu beachten.
ValueSet.status Status

Zeigt den aktuellen Status der Ressource an.
WICHTIGER Hinweis für Implementierer:

  • Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch ‘active’ und ‘retired’’.
  • 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, beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status entered-in-error und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.
ValueSet.url Eindeutige Url des ValueSets

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.useContext Datenelement-Relevanz das ValueSet

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.version Version des ValueSets

Bedeutung: Version des ValueSets

Hinweise: Jede Änderung des dazugehörigen CodeSystems MUSS eine Änderung in der Version des CodeSystems und ValueSets nach sich ziehen.

This structure is derived from ValueSet

Summary

Mandatory: 10 elements
Must-Support: 13 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Version des ValueSets
... name SΣC 1..1 string Name des ValueSets
... status ?!SΣ 1..1 code Status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... useContext SΣ 1..* UsageContext Datenelement-Relevanz das ValueSet
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains SC 1..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 1..1 uri System value for the code
..... version S 1..1 string Version in which this code/display is defined
..... code SC 1..1 code Code - if blank, this is not a selectable code
..... display SC 1..1 string User display for the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.useContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... url S 1..1 uri Eindeutige Url des ValueSets
... name S 1..1 string Name des ValueSets
... status S 1..1 code Status
... useContext S 1..* UsageContext Datenelement-Relevanz das ValueSet
.... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
.... value[x] 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains S 1..* BackboneElement Codes in the value set
..... system S 1..1 uri System value for the code
..... version S 1..1 string Version in which this code/display is defined
..... code S 1..1 code Code - if blank, this is not a selectable code
..... display S 1..1 string User display for the concept

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Eindeutige Url des ValueSets
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version SΣ 1..1 string Version des ValueSets
... name SΣC 1..1 string Name des ValueSets
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code Status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext SΣ 1..* UsageContext Datenelement-Relevanz das ValueSet
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 1..1 BackboneElement Expansion der Konzepte
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains SC 1..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 1..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version S 1..1 string Version in which this code/display is defined
..... code SC 1..1 code Code - if blank, this is not a selectable code
..... display SC 1..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ValueSet.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.useContext.​code Base extensible UsageContextType 📍4.0.1 FHIR Std.
ValueSet.useContext.​value[x] Base required ResourceType 📦4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

This structure is derived from ValueSet

Summary

Mandatory: 10 elements
Must-Support: 13 elements

 

Other representations of profile: CSV, Excel, Schematron