DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 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

6.22.4 6.22.6 Resource NamingSystem - Detailed Descriptions

Detailed Descriptions for the elements in the NamingSystem resource.

code Type
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' not(f:kind/@value='root' and f:uniqueId/f:type=('uuid', f:uniqueId/f:type/@value=('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) distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:primary/@value='true'])>1) f:preferred/@value=true()])>1) then $type else ())))
nsd-3 : Can only have replacedBy if namingsystem naming system is retired (xpath: not(f:replacedBy) or f:status/@value='retired')
NamingSystem.type 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.status
Definition

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. ( Required )
Type code
Is Modifier true
NamingSystem.kind
Definition

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

Control 1..1
Binding NamingSystemType: Required : http://hl7.org/fhir/namingsystem-type (Identifies Identifies the purpose of the namingsystem) naming system. ( Required )
Type code
NamingSystem.name NamingSystem.publisher
Definition

The descriptive name of this particular identifier type the individual or code organization that published the naming system.

Control 1..1 0..1
Type string
Comments Requirements

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

Summary true
Comments

Usually an OID would organization, but may be captured as an extension. individual. This item SHOULD be populated unless the information is available from context.

NamingSystem.date 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 date (and optionally time) when name of an individual to contact regarding the system was registered or published. naming system.

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

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

NamingSystem.status NamingSystem.contact.telecom
Definition

Indicates whether the namingsystem is "ready Contact details for use" individual (if a name was provided) or not. the publisher.

Control 1..1 0..*
Binding Type ConformanceResourceStatus: Required : http://hl7.org/fhir/conformance-resource-status ContactPoint (The lifecycle status
Summary true
NamingSystem.responsible
Definition

The name of a Value Set the organization that is responsible for issuing identifiers or Concept Map) codes for this namespace and ensuring their non-collision.

Control 0..1
Type code string
Is Modifier Comments true

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

NamingSystem.country NamingSystem.date
Definition

If present, indicates that The date (and optionally time) when the identifier or code system is principally intended for use was registered or applies to entities within published. The date must change when the specified country. For example, business version changes, if it does, and it must change if the country associated with a national status code system. changes. In addition, it should change when the substantive content of the registration changes.

Control 0..1 1..1
Binding Type Country: Required : The complete set of ISO country codes, as maintained form time to time dateTime (Codes for identifying countries)
Type Summary true
Comments

Additional specific dates may be added as extensions.

NamingSystem.category NamingSystem.type
Definition

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

Control 0..1
Binding NamingSystemCategory: Identifies the general purpose of the namingsystem identifiers provided. E.g. Driver, Provider, Patient, Bank, etc. 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.

NamingSystem.responsible NamingSystem.description
Definition

The name of Details about what the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. identifies including scope, granularity, version labeling, etc.

Control 0..1
Type string
NamingSystem.useContext
Comments Definition

This is the primary organization. Responsibility for some aspects of The content was developed with a namespace focus and intent of supporting the contexts that are listed. These terms may be delegated. used to assist with indexing and searching of naming systems.

Control NamingSystem.description 0..*
Definition Binding Details about what Context of Use ValueSet: Indicates the namespace identifies including scope, granularity, version labeling, etc. countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. ( Extensible )
Control Type 0..1 CodeableConcept
Requirements

Assist in searching for appropriate content.

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

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 Identifies the style of unique identifier used to identify a namepace) 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.

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

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

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 naming systems that are retired, indicates the namingsystem naming system 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 naming system is retired (xpath: not(f:replacedBy) or f:status/@value='retired')