This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the NamingSystem resource.
NamingSystem | |||||||||||||||||
Element Id | NamingSystem | ||||||||||||||||
Definition | A 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. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | CanonicalResource | ||||||||||||||||
Invariants |
| ||||||||||||||||
NamingSystem.url | |||||||||||||||||
Element Id | NamingSystem.url | ||||||||||||||||
Definition | An absolute URI that is used to identify this naming 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 naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | uri | ||||||||||||||||
Requirements | Allows the naming system to be referenced by a single globally unique identifier. | ||||||||||||||||
Summary | true | ||||||||||||||||
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. | ||||||||||||||||
NamingSystem.version | |||||||||||||||||
Element Id | NamingSystem.version | ||||||||||||||||
Definition | The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming 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. | ||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | There may be different naming 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 naming system with the format [url]|[version]. | ||||||||||||||||
NamingSystem.name | |||||||||||||||||
Element Id | NamingSystem.name | ||||||||||||||||
Definition | A 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. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||
Summary | true | ||||||||||||||||
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.The"symbolic name" for an OID would be captured as an extension. | ||||||||||||||||
Invariants |
| ||||||||||||||||
NamingSystem.status | |||||||||||||||||
Element Id | NamingSystem.status | ||||||||||||||||
Definition | The status of this naming system. Enables tracking the life-cycle of the content. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | Allows filtering of naming systems that are appropriate for use versus not. | ||||||||||||||||
NamingSystem.kind | |||||||||||||||||
Element Id | NamingSystem.kind | ||||||||||||||||
Definition | Indicates the purpose for the naming system - what kinds of things does it make unique? | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Terminology Binding | NamingSystemType (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Summary | true | ||||||||||||||||
NamingSystem.date | |||||||||||||||||
Element Id | NamingSystem.date | ||||||||||||||||
Definition | The date (and optionally time) when the naming 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 naming system changes. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | dateTime | ||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
NamingSystem.publisher | |||||||||||||||||
Element Id | NamingSystem.publisher | ||||||||||||||||
Definition | The name of the organization or individual that published the naming system. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the naming system. May also allow for contact. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
NamingSystem.contact | |||||||||||||||||
Element Id | NamingSystem.contact | ||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | ContactDetail | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||
NamingSystem.responsible | |||||||||||||||||
Element Id | NamingSystem.responsible | ||||||||||||||||
Definition | The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | This is the primary organization. Responsibility for some aspects of a namespace may be delegated. | ||||||||||||||||
NamingSystem.type | |||||||||||||||||
Element Id | NamingSystem.type | ||||||||||||||||
Definition | Categorizes a naming system for easier search by grouping related naming systems. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Terminology Binding | IdentifierType (Extensible) | ||||||||||||||||
Type | CodeableConcept | ||||||||||||||||
Comments | This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well. | ||||||||||||||||
NamingSystem.description | |||||||||||||||||
Element Id | NamingSystem.description | ||||||||||||||||
Definition | A 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | markdown | ||||||||||||||||
Comments | 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 naming system is presumed to be the predominant language in the place the naming system was created). | ||||||||||||||||
NamingSystem.useContext | |||||||||||||||||
Element Id | NamingSystem.useContext | ||||||||||||||||
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 naming system instances. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Type | UsageContext | ||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||
NamingSystem.jurisdiction | |||||||||||||||||
Element Id | NamingSystem.jurisdiction | ||||||||||||||||
Definition | A legal or geographic region in which the naming system is intended to be used. | ||||||||||||||||
Cardinality | 0..* | ||||||||||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||||||||||
Type | CodeableConcept | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||||||||||
NamingSystem.usage | |||||||||||||||||
Element Id | NamingSystem.usage | ||||||||||||||||
Definition | Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
NamingSystem.uniqueId | |||||||||||||||||
Element Id | NamingSystem.uniqueId | ||||||||||||||||
Definition | Indicates how the system may be identified when referenced in electronic exchange. | ||||||||||||||||
Cardinality | 1..* | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc. | ||||||||||||||||
NamingSystem.uniqueId.type | |||||||||||||||||
Element Id | NamingSystem.uniqueId.type | ||||||||||||||||
Definition | Identifies the unique identifier scheme used for this particular identifier. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Terminology Binding | NamingSystemIdentifierType (Required) | ||||||||||||||||
Type | code | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
NamingSystem.uniqueId.value | |||||||||||||||||
Element Id | NamingSystem.uniqueId.value | ||||||||||||||||
Definition | The string that should be sent over the wire to identify the code system or identifier system. | ||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Summary | true | ||||||||||||||||
Comments | 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. | ||||||||||||||||
NamingSystem.uniqueId.preferred | |||||||||||||||||
Element Id | NamingSystem.uniqueId.preferred | ||||||||||||||||
Definition | Indicates whether this identifier is the "preferred" identifier of this type. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | boolean | ||||||||||||||||
Meaning if Missing | 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 | ||||||||||||||||
NamingSystem.uniqueId.comment | |||||||||||||||||
Element Id | NamingSystem.uniqueId.comment | ||||||||||||||||
Definition | Notes about the past or intended usage of this identifier. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | string | ||||||||||||||||
Comments | e.g. "must be used in Germany" or "was initially published in error with this value". | ||||||||||||||||
NamingSystem.uniqueId.period | |||||||||||||||||
Element Id | NamingSystem.uniqueId.period | ||||||||||||||||
Definition | Identifies 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. | ||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||
Type | Period | ||||||||||||||||
Comments | 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). |