DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

6.22.6 4.9.7 Resource NamingSystem - Detailed Descriptions Resource NamingSystem - Detailed Descriptions Detailed Descriptions for the elements in the NamingSystem resource.

Detailed Descriptions for the elements in the NamingSystem resource.

Requirements Helps establish the "authority/credibility" of the naming system. May also allow for contact. true | Version History | Table of Contents | Compare to DSTU1
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. 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 Defined on this element
nsd-1 : Root systems cannot have uuid or sid identifiers (xpath: not(f:kind/@value='root' and f:uniqueId/f:type/@value=('uuid', 'ruid'))) : 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 (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 ()))) : Can't have more than one preferred identifier for a type ( expression : uniqueId.where(preferred = true).select(type).isDistinct(), 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 (xpath: not(f:replacedBy) or f:status/@value='retired') : 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. 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. 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. Indicates whether the naming system is "ready for use" or not.

Control 1..1
Binding ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. ( ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. ( Required )
Type code
Is Modifier Is Modifier true
Summary true
NamingSystem.kind
Definition

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

Control 1..1
Binding NamingSystemType: Identifies the purpose of the naming system. ( NamingSystemType: Identifies the purpose of the naming system. ( Required )
Type code
NamingSystem.publisher NamingSystem.date
Definition

The name of the individual or organization that published the naming system. 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.

Control 0..1 1..1
Type string dateTime
Summary true
Comments

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. Additional specific dates may be added as extensions.

NamingSystem.contact NamingSystem.publisher
Definition

Contacts to assist a user in finding and communicating with the publisher. The name of the individual or organization that published the naming system.

Control 0..* 0..1
Type string
Requirements

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

Summary true
Comments

May be a web site, an email address, a telephone number (tel:), etc. Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

NamingSystem.contact.name NamingSystem.contact
Definition

The name of an individual to contact regarding the naming system. Contacts to assist a user in finding and communicating with the publisher.

Control 0..1 Type string 0..*
Summary true
Comments

If there is no named individual, the telecom is for the organization as a whole. May be a web site, an email address, a telephone number (tel:), etc.

NamingSystem.contact.telecom NamingSystem.contact.name
Definition

Contact details for individual (if a name was provided) or the publisher. The name of an individual to contact regarding the naming system.

Control 0..* 0..1
Type ContactPoint string
Summary true
Comments

If there is no named individual, the telecom is for the organization as a whole.

NamingSystem.responsible NamingSystem.contact.telecom
Definition

The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. Contact details for individual (if a name was provided) or the publisher.

Control 0..1 0..*
Type string ContactPoint
Comments Summary This is the primary organization. Responsibility for some aspects of a namespace may be delegated. true
NamingSystem.date NamingSystem.responsible
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. The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

Control 1..1 0..1
Type dateTime Summary string
Comments

Additional specific dates may be added as extensions. 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. Categorizes a naming system for easier search by grouping related naming systems.

Control 0..1
Binding Identifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ( Identifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ( 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. 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. Details about what the namespace identifies including scope, granularity, version labeling, etc.

Control 0..1
Type string markdown
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. 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.

Control 0..*
Binding Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. ( Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. ( Extensible )
Type CodeableConcept
Requirements

Assist in searching for appropriate content. Assist in searching for appropriate content.

Summary true
NamingSystem.usage
Definition

Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. 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. 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. 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. Identifies the unique identifier scheme used for this particular identifier.

Control 1..1
Binding NamingSystemIdentifierType: Identifies the style of unique identifier used to identify a namespace. ( NamingSystemIdentifierType: Identifies the style of unique identifier used to identify a namespace. ( Required )
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. 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. The string that should be sent over the wire to identify the code system or identifier system.

Control 1..1
Type string
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. 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. Indicates whether this identifier is the "preferred" identifier of this type.

Control 0..1
Type boolean
Meaning if Missing 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 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.comment
Definition

Notes about the past or intended usage of this identifier.

Control 0..1
Type string
Comments

e.g. "must be used in Germany" or "was initially published in error with this value".

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

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). 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). For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Control 0..1
Type Reference ( NamingSystem )
Invariants Affect this element Affect this element
nsd-3 : Can only have replacedBy if naming system is retired (xpath: not(f:replacedBy) or f:status/@value='retired') : Can only have replacedBy if naming system is retired ( expression © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search : replacedBy.empty() or status = 'retired', xpath: not(f:replacedBy) or f:status/@value='retired')