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/v2/Basismodul/StructureDefinition/ISiKCodeSystem |
CodeSystem | I | CodeSystem | There are no (further) constraints on this element Element idCodeSystem Declares the existence of and describes a code system or code system supplement DefinitionThe 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.
| |
id | S Σ | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCodeSystem.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idCodeSystem.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idCodeSystem.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idCodeSystem.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idCodeSystem.url Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) DefinitionAn 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. Allows the code system to be referenced by a single globally unique identifier. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idCodeSystem.identifier Additional identifier for the code system (business identifier) DefinitionA 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. Allows externally provided and/or usable business identifiers to be easily associated with the module. 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.
|
version | S Σ | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.version Business version of the code system (Coding.version) DefinitionThe 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. 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].
|
name | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.name Name for this code system (computer friendly) DefinitionA 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. Support human navigation and code generation. 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.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.title Name for this code system (human friendly) DefinitionA short, descriptive, user-friendly title for the code system. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.status draft | active | retired | unknown DefinitionThe date (and optionally time) when the code system resource was created or revised. Allows filtering of code systems that are appropriate for use versus not. The lifecycle status of an artifact.
|
experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCodeSystem.experimental For testing purposes, not real usage DefinitionA 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. Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system. Allows filtering of code systems that are appropriate for use versus not.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idCodeSystem.date Date last changed Alternate namesRevision Date DefinitionThe 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. 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.
|
publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the code system. Helps establish the "authority/credibility" of the code system. May also allow for contact. 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.
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idCodeSystem.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
description | 0..1 | markdown | There are no (further) constraints on this element Element idCodeSystem.description Natural language description of the code system Alternate namesScope, Purpose DefinitionA free text natural language description of the code system from a consumer's perspective. 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).
| |
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idCodeSystem.useContext The context that the content is intended to support DefinitionThe 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. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idCodeSystem.jurisdiction Intended jurisdiction for code system (if applicable) DefinitionA legal or geographic region in which the code system is intended to be used. It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use.
|
purpose | 0..1 | markdown | There are no (further) constraints on this element Element idCodeSystem.purpose Why this code system is defined DefinitionExplanation of why this code system is needed and why it has been designed as it has. 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.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element idCodeSystem.copyright Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA 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. Consumers must be able to determine any legal restrictions on the use of the code system and/or its content. 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.
| |
caseSensitive | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCodeSystem.caseSensitive If code comparison is case sensitive DefinitionIf code comparison is case sensitive when codes within this system are compared to each other. 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.
|
valueSet | Σ | 0..1 | canonical(ValueSet) | There are no (further) constraints on this element Element idCodeSystem.valueSet Canonical reference to the value set with entire code system DefinitionCanonical reference to the value set that contains the entire code system. 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.
|
hierarchyMeaning | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.hierarchyMeaning grouped-by | is-a | part-of | classified-with DefinitionThe meaning of the hierarchy of concepts as represented in this resource. Note that other representations might have a different hierarchy or none at all, and represent the information using properties. The meaning of the hierarchy of concepts in a code system.
|
compositional | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCodeSystem.compositional If code system defines a compositional grammar Alternate namesgrammar DefinitionThe code system defines a compositional (post-coordination) grammar. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.
|
versionNeeded | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idCodeSystem.versionNeeded If definitions are not stable DefinitionThis 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. 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.
|
content | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.content not-present | example | fragment | complete | supplement DefinitionThe extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. Note that FHIR strings SHALL NOT exceed 1MB in size The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
|
supplements | Σ | 0..1 | canonical(CodeSystem) | There are no (further) constraints on this element Element idCodeSystem.supplements Canonical URL of Code System this adds designations and properties to DefinitionThe canonical URL of the code system that this code system supplement is adding designations and properties to. The most common use of a code system supplement is to add additional language support.
|
count | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idCodeSystem.count Total concepts in the code system DefinitionThe 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. 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.
|
filter | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.filter Filter that can be used in a value set DefinitionA filter that can be used in a value set compose statement when selecting concepts using a filter. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.filter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.filter.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.filter.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idCodeSystem.filter.code Code that identifies the filter DefinitionThe code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter. Note that FHIR strings SHALL NOT exceed 1MB in size
|
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.filter.description How or why the filter is used DefinitionA description of how or why the filter is used. Note that FHIR strings SHALL NOT exceed 1MB in size
|
operator | Σ | 1..* | codeBinding | There are no (further) constraints on this element Element idCodeSystem.filter.operator = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists DefinitionA list of operators that can be used with the filter. Note that FHIR strings SHALL NOT exceed 1MB in size The kind of operation to perform as a part of a property based filter.
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.filter.value What to use for the value DefinitionA description of what the value for the filter should be. Note that FHIR strings SHALL NOT exceed 1MB in size
|
property | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.property Additional information supplied about each concept DefinitionA property defines an additional slot through which additional information can be provided about a concept.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.property.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.property.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.property.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idCodeSystem.property.code Identifies the property on the concepts, and when referred to in operations DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
uri | Σ | 0..1 | uri | There are no (further) constraints on this element Element idCodeSystem.property.uri Formal identifier for the property DefinitionReference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.property.description Why the property is defined, and/or what it conveys DefinitionA description of the property- why it is defined, and how its value might be used. Note that FHIR strings SHALL NOT exceed 1MB in size
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.property.type code | Coding | string | integer | boolean | dateTime | decimal DefinitionThe 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). Note that FHIR strings SHALL NOT exceed 1MB in size The type of a property value.
|
concept | S | 1..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept Concepts in the code system DefinitionConcepts 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. If this is empty, it means that the code system resource does not represent the content of the code system.
|
id | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | S | 1..1 | code | There are no (further) constraints on this element Element idCodeSystem.concept.code Code that identifies concept DefinitionA code - a text symbol - that uniquely identifies the concept within the code system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.display Text to display to the user DefinitionA human readable string that is the recommended default way to present this concept to a user. Note that FHIR strings SHALL NOT exceed 1MB in size
|
definition | S | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.definition Formal definition DefinitionThe 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
designation | 0..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept.designation Additional representations for the concept DefinitionAdditional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. Concepts have both a
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.designation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.designation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.designation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idCodeSystem.concept.designation.language Human language of the designation DefinitionThe language this designation is defined for. In the absence of a language, the resource language applies. A human language.
| |
use | 0..1 | CodingBinding | There are no (further) constraints on this element Element idCodeSystem.concept.designation.use Details how this designation would be used DefinitionA code that details how this designation would be used. If no use is provided, the designation can be assumed to be suitable for general display to a human user. Details of how a designation would be used.
| |
value | 1..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.designation.value The text value for this designation DefinitionThe text value for this designation. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
property | 0..* | BackboneElement | There are no (further) constraints on this element Element idCodeSystem.concept.property Property value for the concept DefinitionA property value for this concept.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idCodeSystem.concept.property.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.property.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idCodeSystem.concept.property.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | 1..1 | code | There are no (further) constraints on this element Element idCodeSystem.concept.property.code Reference to CodeSystem.property.code DefinitionA code that is a reference to CodeSystem.property.code. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idCodeSystem.concept.property.value[x] Value of the property for this concept DefinitionThe value of this property.
| ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
concept | 0..* | see (concept) | There are no (further) constraints on this element Element idCodeSystem.concept.concept Child Concepts (is-a/contains/categorizes) DefinitionDefines 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/v2/Basismodul/StructureDefinition/ISiKCodeSystem" ] }, "url": "http://example.org/fhir/CodeSystem/TestKatalog", "version": "2.0.2", "name": "TestKatalog", "status": "active", "content": "complete", "concept": [ { "code": "test", "display": "Test", "definition": "Dies ist ein Test-Code" } ] }