STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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

6.26.6 Resource NamingSystem - Detailed Descriptions

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.

Control1..1
InvariantsDefined on this element
nsd-1: Root systems cannot have uuid identifiers (expression: kind != 'root' or uniqueId.type = 'uuid', xpath: not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid'))
nsd-2: Can't have more than one preferred identifier for a type (expression: uniqueId.where(preferred = true).select(type).distinct(), xpath: not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ())))
nsd-3: Can only have replacedBy if naming system is retired (expression: replacedBy.empty() or status = 'retired', xpath: not(f:replacedBy) or f:status/@value='retired')
NamingSystem.name
Definition

The descriptive name of this particular identifier type or code system.

Control1..1
Typestring
Comments

The"symbolic name" for an OID would be captured as an extension.

NamingSystem.status
Definition

Indicates whether the naming system is "ready for use" or not.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
NamingSystem.kind
Definition

Indicates the purpose for the naming system - what kinds of things does it make unique?

Control1..1
BindingNamingSystemType: Identifies the purpose of the naming system. (Required)
Typecode
NamingSystem.date
Definition

The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes.

Control1..1
TypedateTime
Summarytrue
Comments

Additional specific dates may be added as extensions.

NamingSystem.publisher
Definition

The name of the individual or organization that published the naming system.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the naming system. May also allow for contact.

Summarytrue
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.

Control0..*
Summarytrue
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.

Control0..1
Typestring
Summarytrue
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.

Control0..*
TypeContactPoint
Summarytrue
NamingSystem.responsible
Definition

The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

Control0..1
Typestring
Comments

This is the primary organization. Responsibility for some aspects of a namespace may be delegated.

NamingSystem.type
Definition

Categorizes a naming system for easier search by grouping related naming systems.

Control0..1
BindingIdentifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Extensible)
TypeCodeableConcept
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
Definition

Details about what the namespace identifies including scope, granularity, version labeling, etc.

Control0..1
Typestring
NamingSystem.useContext
Definition

The 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 of naming systems.

Control0..*
BindingContext of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible)
TypeCodeableConcept
Requirements

Assist in searching for appropriate content.

Summarytrue
NamingSystem.usage
Definition

Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

Control0..1
Typestring
NamingSystem.uniqueId
Definition

Indicates how the system may be identified when referenced in electronic exchange.

Control1..*
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.

Control1..1
BindingNamingSystemIdentifierType: Identifies the style of unique identifier used to identify a namespace. (Required)
Typecode
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.

Control1..1
Typestring
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
Definition

Indicates whether this identifier is the "preferred" identifier of this type.

Control0..1
Typeboolean
Meaning if MissingIf 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 naming system. Outside of this window, the identifier might be non-deterministic.

Control0..1
TypePeriod
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.replacedBy
Definition

For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Control0..1
TypeReference(NamingSystem)
InvariantsAffect this element
nsd-3: Can only have replacedBy if naming system is retired (expression: replacedBy.empty() or status = 'retired', xpath: not(f:replacedBy) or f:status/@value='retired')