Implementierungsleitfaden ISiK-Basismodul

Katalog (CodeSystem)

Motivation

Katalog

ISiK erlaubt in diversen Kontexten die Erweiterung der Kodierung durch Krankenhaus-/Systeminterne Kodierungen. Das Profil ISiKKatalog (CodeSystem) als Profil erlaubt die Repräsentation der dazugehörigen Codes und Displaywerte.

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.

Normativer Status und Bestätigung

Dieses Profil MUSS im Rahmen der Bestätigung NICHT unterstützt werden. Falls das Profil unterstützt werden soll, MÜSSEN die hier definierten Festlegungen greifen (auch im Bestätigungsverfahren).

FHIR-Profil

Name	Canonical
ISiKCodeSystem	https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKCodeSystem

CodeSystem	I		CodeSystem	There are no (further) constraints on this element Element Id CodeSystem Short description Declares the existence of and describes a code system or code system supplement Definition The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content. Data Type CodeSystem Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` csd-1:Within a code system definition, all the codes SHALL be unique `concept.code.combine($this.descendants().concept.code).isDistinct()` csd-0: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}')` Mappings rim:Entity. Role, or Act rim:N/A
id	S Σ	1..1	System.String	There are no (further) constraints on this element Element Id CodeSystem.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data Type System.String
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id CodeSystem.url Short description Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) Definition An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system. Requirements Allows the code system to be referenced by a single globally unique identifier. Comments Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id CodeSystem.identifier Short description Additional identifier for the code system (business identifier) Definition A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Definition.identifier w5:FiveWs.identifier objimpl:no-gen-base
version	S Σ	1..1	string	There are no (further) constraints on this element Element Id CodeSystem.version Short description Business version of the code system (Coding.version) Definition The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version. Comments There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]\|[version]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	S Σ I	1..1	string	There are no (further) constraints on this element Element Id CodeSystem.name Short description Name for this code system (computer friendly) Definition A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. Requirements Support human navigation and code generation. Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id CodeSystem.title Short description Name for this code system (human friendly) Definition A short, descriptive, user-friendly title for the code system. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.status Short description draft \| active \| retired \| unknown Definition The date (and optionally time) when the code system resource was created or revised. Comments Allows filtering of code systems that are appropriate for use versus not. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CodeSystem.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system. Comments Allows filtering of code systems that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id CodeSystem.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	0..1	string	There are no (further) constraints on this element Element Id CodeSystem.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the code system. Requirements Helps establish the "authority/credibility" of the code system. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id CodeSystem.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description		0..1	markdown	There are no (further) constraints on this element Element Id CodeSystem.description Short description Natural language description of the code system Alternate names Scope, Purpose Definition A free text natural language description of the code system from a consumer's perspective. Comments This description can be used to capture details such as why the code system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created). Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description rim:N/A
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id CodeSystem.useContext Short description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id CodeSystem.jurisdiction Short description Intended jurisdiction for code system (if applicable) Definition A legal or geographic region in which the code system is intended to be used. Comments It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Definition.jurisdiction
purpose		0..1	markdown	There are no (further) constraints on this element Element Id CodeSystem.purpose Short description Why this code system is defined Definition Explanation of why this code system is needed and why it has been designed as it has. Comments This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id CodeSystem.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. Requirements Consumers must be able to determine any legal restrictions on the use of the code system and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required. Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
caseSensitive	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CodeSystem.caseSensitive Short description If code comparison is case sensitive Definition If code comparison is case sensitive when codes within this system are compared to each other. Comments If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
valueSet	Σ	0..1	canonical(ValueSet)	There are no (further) constraints on this element Element Id CodeSystem.valueSet Short description Canonical reference to the value set with entire code system Definition Canonical reference to the value set that contains the entire code system. Comments The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable. Data Type canonical(ValueSet) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
hierarchyMeaning	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.hierarchyMeaning Short description grouped-by \| is-a \| part-of \| classified-with Definition The meaning of the hierarchy of concepts as represented in this resource. Comments Note that other representations might have a different hierarchy or none at all, and represent the information using properties. Data Type code Binding The meaning of the hierarchy of concepts in a code system. CodeSystemHierarchyMeaning (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
compositional	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CodeSystem.compositional Short description If code system defines a compositional grammar Alternate names grammar Definition The code system defines a compositional (post-coordination) grammar. Comments Note that the code system resource does not define what the compositional grammar is, only whether or not there is one. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
versionNeeded	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CodeSystem.versionNeeded Short description If definitions are not stable Definition This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system. Comments Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'. Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
content	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.content Short description not-present \| example \| fragment \| complete \| supplement Definition The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. CodeSystemContentMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
supplements	Σ	0..1	canonical(CodeSystem)	There are no (further) constraints on this element Element Id CodeSystem.supplements Short description Canonical URL of Code System this adds designations and properties to Definition The canonical URL of the code system that this code system supplement is adding designations and properties to. Comments The most common use of a code system supplement is to add additional language support. Data Type canonical(CodeSystem) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
count	Σ	0..1	unsignedInt	There are no (further) constraints on this element Element Id CodeSystem.count Short description Total concepts in the code system Definition The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward. Comments The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element. Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
filter	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CodeSystem.filter Short description Filter that can be used in a value set Definition A filter that can be used in a value set compose statement when selecting concepts using a filter. Comments Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code	Σ	1..1	code	There are no (further) constraints on this element Element Id CodeSystem.filter.code Short description Code that identifies the filter Definition The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
description	Σ	0..1	string	There are no (further) constraints on this element Element Id CodeSystem.filter.description Short description How or why the filter is used Definition A description of how or why the filter is used. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
operator	Σ	1..*	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.filter.operator Short description = \| is-a \| descendent-of \| is-not-a \| regex \| in \| not-in \| generalizes \| exists Definition A list of operators that can be used with the filter. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The kind of operation to perform as a part of a property based filter. FilterOperator (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
value	Σ	1..1	string	There are no (further) constraints on this element Element Id CodeSystem.filter.value Short description What to use for the value Definition A description of what the value for the filter should be. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
property	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CodeSystem.property Short description Additional information supplied about each concept Definition A property defines an additional slot through which additional information can be provided about a concept. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code	Σ	1..1	code	There are no (further) constraints on this element Element Id CodeSystem.property.code Short description Identifies the property on the concepts, and when referred to in operations Definition A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
uri	Σ	0..1	uri	There are no (further) constraints on this element Element Id CodeSystem.property.uri Short description Formal identifier for the property Definition Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
description	Σ	0..1	string	There are no (further) constraints on this element Element Id CodeSystem.property.description Short description Why the property is defined, and/or what it conveys Definition A description of the property- why it is defined, and how its value might be used. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.property.type Short description code \| Coding \| string \| integer \| boolean \| dateTime \| decimal Definition The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of a property value. PropertyType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
concept	S	1..*	BackboneElement	There are no (further) constraints on this element Element Id CodeSystem.concept Short description Concepts in the code system Definition Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are. Comments If this is empty, it means that the code system resource does not represent the content of the code system. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code	S	1..1	code	There are no (further) constraints on this element Element Id CodeSystem.concept.code Short description Code that identifies concept Definition A code - a text symbol - that uniquely identifies the concept within the code system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
display	S	1..1	string	There are no (further) constraints on this element Element Id CodeSystem.concept.display Short description Text to display to the user Definition A human readable string that is the recommended default way to present this concept to a user. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition	S	0..1	string	There are no (further) constraints on this element Element Id CodeSystem.concept.definition Short description Formal definition Definition The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
designation		0..*	BackboneElement	There are no (further) constraints on this element Element Id CodeSystem.concept.designation Short description Additional representations for the concept Definition Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Requirements Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. Comments Concepts have both a `display` and an array of `designation`. The display is equivalent to a special designation with an implied `designation.use` of "primary code" and a language equal to the Resource Language. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element Id CodeSystem.concept.designation.language Short description Human language of the designation Definition The language this designation is defined for. Comments In the absence of a language, the resource language applies. Data Type code Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
use		0..1	CodingBinding	There are no (further) constraints on this element Element Id CodeSystem.concept.designation.use Short description Details how this designation would be used Definition A code that details how this designation would be used. Comments If no use is provided, the designation can be assumed to be suitable for general display to a human user. Data Type Coding Binding Details of how a designation would be used. DesignationUse (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
value		1..1	string	There are no (further) constraints on this element Element Id CodeSystem.concept.designation.value Short description The text value for this designation Definition The text value for this designation. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
property		0..*	BackboneElement	There are no (further) constraints on this element Element Id CodeSystem.concept.property Short description Property value for the concept Definition A property value for this concept. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code		1..1	code	There are no (further) constraints on this element Element Id CodeSystem.concept.property.code Short description Reference to CodeSystem.property.code Definition A code that is a reference to CodeSystem.property.code. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
value[x]		1..1		There are no (further) constraints on this element Element Id CodeSystem.concept.property.value[x] Short description Value of the property for this concept Definition The value of this property. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
valueCode			code	There are no (further) constraints on this element Data Type code
valueCoding			Coding	There are no (further) constraints on this element Data Type Coding
valueString			string	There are no (further) constraints on this element Data Type string
valueInteger			integer	There are no (further) constraints on this element Data Type integer
valueBoolean			boolean	There are no (further) constraints on this element Data Type boolean
valueDateTime			dateTime	There are no (further) constraints on this element Data Type dateTime
valueDecimal			decimal	There are no (further) constraints on this element Data Type decimal
concept		0..*	see (concept)	There are no (further) constraints on this element Element Id CodeSystem.concept.concept Short description Child Concepts (is-a/contains/categorizes) Definition Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.

Interaktionen

Für die Ressource CodeSystem MUSS die REST-Interaktion "READ" implementiert werden, falls die Resource CodeSystem umgesetzt wird.

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

Der Suchparameter "_id" MUSS unterstützt werden, falls die Resource CodeSystem umgesetzt wird:

Beispiele:

GET [base]/CodeSystem?_id=103270

Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "url" MUSS unterstützt werden, falls die Resource CodeSystem umgesetzt wird:

Beispiele:

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

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

Anmerkungen zu Must-Support-Feldern

`CodeSystem.url`

Bedeutung: Eindeutige Url zur Identifizierung des CodeSystems. Absolute Url sind zu bevorzugen.

Hinweise: OIDs SOLLTEN als weitere Identifier des CodeSystems verwendet werden. In jedem Fall SOLLTE ein Canonical Url vergeben werden.

`CodeSystem.version`

Bedeutung: Version des CodeSystems

Hinweise: Jede Änderung des CodeSystems MUSS eine Änderung in der Version des CodeSystems und gebundenen ValueSets nach sich ziehen. Die Versionierung SOLLTE auf Basis von Semantic Versioning basieren.

`CodeSystem.name`

Bedeutung: Maschinenlesbarer Name des CodeSystems

Hinweise: Der Constraint cps-0 ist hierbei zu beachten.

`CodeSystem.status`

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

`CodeSystem.content`

Bedeutung: Angabe, ob es sich um eine vollständige Repräsentation des CodeSystems oder nur um einen Auszug handelt.

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.

`CodeSystem.concept`

Bedeutung: Angabe der Konzepte, aus denen sich das CodeSystem zusammensetzt.

Hinweise: Es MUSS mindestens ein Code und ein Anzeigetext spezifiziert werden.

Beispiele

Valides Minimalbeispiel CodeSystem:

{
    "resourceType": "CodeSystem",
    "id": "CodeSystemExample",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKCodeSystem"
        ]
    },
    "version": "3.0.4",
    "status": "active",
    "experimental": false,
    "publisher": "gematik GmbH",
    "date": "2024-03-01",
    "url": "http://example.org/fhir/CodeSystem/TestKatalog",
    "name": "TestKatalog",
    "content": "complete",
    "concept":  [
        {
            "code": "test",
            "display": "Test",
            "definition": "Dies ist ein Test-Code"
        }
    ]
}