This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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
Detailed Descriptions for the elements in the NamingSystem resource.
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. |
Control | 1..1 |
Invariants | Defined on this element nsd-1: Root systems cannot have uuid or sid identifiers (xpath: not(f:type/@value='root' and f:uniqueId/f:type=('uuid', 'ruid'))) nsd-2: Can't have more than one preferred identifier for a type (xpath: not(exists(for $type in distinct-values(f:uniqueId/f:type) return if (count(f:uniqueId[f:type/@value=$type and f:primary/@value='true'])>1) then $type else ()))) nsd-3: Can only have replacedBy if namingsystem is retired (xpath: not(f:replacedBy) or f:status/@value='retired') |
NamingSystem.type | |
Definition | Indicates the purpose for the namingsystem - what kinds of things does it make unique? |
Control | 1..1 |
Binding | NamingSystemType: Required: http://hl7.org/fhir/namingsystem-type (Identifies the purpose of the namingsystem) |
Type | code |
NamingSystem.name | |
Definition | The descriptive name of this particular identifier type or code system. |
Control | 1..1 |
Type | string |
Comments | The"symbolic name" for an OID would be captured as an extension. |
NamingSystem.date | |
Definition | The date (and optionally time) when the system was registered or published. |
Control | 1..1 |
Type | dateTime |
Summary | true |
NamingSystem.status | |
Definition | Indicates whether the namingsystem is "ready for use" or not. |
Control | 1..1 |
Binding | ConformanceResourceStatus: Required: http://hl7.org/fhir/conformance-resource-status (The lifecycle status of a Value Set or Concept Map) |
Type | code |
Is Modifier | true |
NamingSystem.country | |
Definition | If present, indicates that the identifier or code system is principally intended for use or applies to entities within the specified country. For example, the country associated with a national code system. |
Control | 0..1 |
Binding | Country: Required: The complete set of ISO country codes, as maintained form time to time (Codes for identifying countries) |
Type | code |
NamingSystem.category | |
Definition | Categorizes a namingsystem for easier search by grouping related namingsystems. |
Control | 0..1 |
Binding | NamingSystemCategory: Identifies the general purpose of the namingsystem identifiers provided. E.g. Driver, Provider, Patient, Bank, etc. |
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.responsible | |
Definition | The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. |
Control | 0..1 |
Type | string |
Comments | This is the primary organization. Responsibility for some aspects of a namespace may be delegated. |
NamingSystem.description | |
Definition | Details about what the namespace identifies including scope, granularity, version labeling, etc. |
Control | 0..1 |
Type | string |
NamingSystem.usage | |
Definition | Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. |
Control | 0..1 |
Type | string |
NamingSystem.uniqueId | |
Definition | Indicates how the system may be identified when referenced in electronic exchange. |
Control | 1..* |
Comments | Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc. |
NamingSystem.uniqueId.type | |
Definition | Identifies the unique identifier scheme used for this particular identifier. |
Control | 1..1 |
Binding | NamingSystemIdentifierType: Required: http://hl7.org/fhir/namingsystem-identifier-type (Identifies the style of unique identifier used to identify a namepace) |
Type | code |
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 | |
Definition | The string that should be sent over the wire to identify the code system or identifier system. |
Control | 1..1 |
Type | string |
NamingSystem.uniqueId.preferred | |
Definition | Indicates whether this identifier is the "preferred" identifier of this type. |
Control | 0..1 |
Type | boolean |
Meaning if Missing | If there are multiple ids, and one is labelled "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.period | |
Definition | Identifies the period of time over which this identifier is considered appropriate to refer to the namingsystem. Outside of this window, the identifier might be non-deterministic. |
Control | 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). |
NamingSystem.publisher | |
Definition | The name of the individual or organization that published the naming system. |
Control | 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. This item SHOULD be populated unless the information is available from context. |
NamingSystem.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
NamingSystem.contact.name | |
Definition | The name of an individual to contact regarding the naming system. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
NamingSystem.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
NamingSystem.replacedBy | |
Definition | For namingsystems that are retired, indicates the namingsystem that should be used in their place (if any). |
Control | 0..1 |
Type | Reference(NamingSystem) |
Invariants | Affect this element nsd-3: Can only have replacedBy if namingsystem is retired (xpath: not(f:replacedBy) or f:status/@value='retired') |