Namensraum
Canonical URL: http://fhir.de/StructureDefinition/namingsystem-de-basis/0.2
Alle in den deutschen Basisprofilen sowie hiervon abgeleiteten Profilen verwendeten Namensräume (NameSpace-Ressourcen) müssen dem nachfolgenden Profile entsprechen. Werden im Rahmen von hersteller- oder projektspezifischen Implementierungen Namensräume benötigt, gilt dies entsprechend.
Dieses Profil stellt sicher, dass für jeden Namensraum ein Typ festgelegt ist.
Auf diese Weise können gleichartige, aber unterschiedliche Namensräume gruppiert werden. Dies ist beispielsweise bei Versichertennummern in der privaten Krankenversicherung sinnvoll.
| namingsystem-de-basis-0.2 (NamingSystem) | C | NamingSystem | There are no (further) constraints on this element Element idNamingSystemShort description System of unique identification DefinitionA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idNamingSystem.idShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idNamingSystem.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idNamingSystem.implicitRulesShort description 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. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idNamingSystem.languageShort description 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. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idNamingSystem.textShort description 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 may 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 in formation is added later. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idNamingSystem.containedShort description 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idNamingSystem.extensionShort description 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. In order 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. 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idNamingSystem.modifierExtensionShort description 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. Usually modifier elements provide negation or qualification. In order 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. 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | string | There are no (further) constraints on this element Element idNamingSystem.nameShort description Name for this naming system (computer friendly) DefinitionA natural language name identifying the naming 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 alpha-numeric type name to ensure that it is computable friendly. The"symbolic name" for an OID would be captured as an extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idNamingSystem.statusShort description draft | active | retired | unknown DefinitionThe status of this naming system. Enables tracking the life-cycle of the content. Allows filtering of naming systems that are appropriate for use vs. not. The lifecycle status of a Value Set or Concept Map. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| kind | 1..1 | codeBinding | There are no (further) constraints on this element Element idNamingSystem.kindShort description codesystem | identifier | root DefinitionIndicates the purpose for the naming system - what kinds of things does it make unique? Note that FHIR strings may not exceed 1MB in size Identifies the purpose of the naming system. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idNamingSystem.dateShort description Date this was last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the naming system was published. The date must change if and 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 naming 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 naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idNamingSystem.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the individual or organization that published the naming system. Helps establish the "authority/credibility" of the naming system. May also allow for contact. Usually an organization, but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming 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 naming system. This item SHOULD be populated unless the information is available from context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idNamingSystem.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| responsible | 0..1 | string | There are no (further) constraints on this element Element idNamingSystem.responsibleShort description Who maintains system namespace? DefinitionThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization. Responsibility for some aspects of a namespace may be delegated. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| type | S | 1..1 | CodeableConceptBinding | Element idNamingSystem.typeShort description Typ des beschriebenen NamingSystems DefinitionTyp (Gruppe) des beschriebenen NamingSystems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. identifier-type-de-basis (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | 0..1 | markdown | There are no (further) constraints on this element Element idNamingSystem.descriptionShort description Natural language description of the naming system DefinitionA free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc. This description can be used to capture details such as why the naming 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 naming 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 profile is presumed to be the predominant language in the place the profile was created). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idNamingSystem.useContextShort description Context the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idNamingSystem.jurisdictionShort description Intended jurisdiction for naming system (if applicable) DefinitionA legal or geographic region in which the naming system is intended to be used. It may be possible for the naming 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 Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| usage | 0..1 | string | There are no (further) constraints on this element Element idNamingSystem.usageShort description How/where is it used DefinitionProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| uniqueId | 1..* | BackboneElement | There are no (further) constraints on this element Element idNamingSystem.uniqueIdShort description Unique identifiers used for system DefinitionIndicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idNamingSystem.uniqueId.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idNamingSystem.uniqueId.extensionShort description 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. In order 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. 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idNamingSystem.uniqueId.modifierExtensionShort description Extensions that cannot be ignored 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 1..1 | codeBinding | There are no (further) constraints on this element Element idNamingSystem.uniqueId.typeShort description oid | uuid | uri | other DefinitionIdentifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc. Identifies the style of unique identifier used to identify a namespace. NamingSystemIdentifierType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| value | 1..1 | string | There are no (further) constraints on this element Element idNamingSystem.uniqueId.valueShort description The unique identifier DefinitionThe string that should be sent over the wire to identify the code system or identifier system. If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idNamingSystem.uniqueId.preferredShort description Is this the id that should be used for this type DefinitionIndicates whether this identifier is the "preferred" identifier of this type. If there are multiple ids, and one is labeled "preferred", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| comment | 0..1 | string | There are no (further) constraints on this element Element idNamingSystem.uniqueId.commentShort description Notes about identifier usage DefinitionNotes about the past or intended usage of this identifier. e.g. "must be used in Germany" or "was initially published in error with this value". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idNamingSystem.uniqueId.periodShort description When is identifier valid? DefinitionIdentifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replacedBy | C | 0..1 | Reference(NamingSystem) | There are no (further) constraints on this element Element idNamingSystem.replacedByShort description Use this instead DefinitionFor naming systems that are retired, indicates the naming system that should be used in their place (if any). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1, nsd-3 Constraints
|