FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.11 Resource NamingSystem - Content

Terminology Infrastructure icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

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.

4.11.1 Scope and Usage

Defines a specific code system or identifier system, so that it can be noted in a registry for other systems to find and understand an identifier.

4.11.2 Boundaries and Relationships

A NamingSystem resource manages identifiers of a code system or identifier system, identifier metadata (e.g. type), and limited code system or identifier system specific metadata (e.g. publisher and description). A CodeSystem resource represents a code system, its key properties, and may include the content, identifiers, and other metadata. There is known overlap between the CodeSystem and NamingSystem resource elements. However, the key differences between the resources are as follows:

  • CodeSystem resources may include the concept and property content of the code system, whereas NamingSystem resources do not. CodeSystem resources also allow identifiers to be supplemented by specific metadata. The metadata are supported with extensions.
  • NamingSystem resources allow the identifiers for code systems or identifier systems to be supplemented by metadata specific to the identifiers. For example: preferred, authoritative, and validity period.

4.11.3 Background and Context

For discussion of policy for creating well maintained OIDs and URIs for resources, see The HL7 Confluence site icon.

4.11.4 References to this Resource

No references for this Resource.

4.11.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem TU DomainResource System of unique identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Root systems cannot have uuid identifiers
+ Rule: Can't have more than one preferred identifier for a type
+ Rule: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC 0..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the naming system (business identifier)

... version Σ 0..1 string Business version of the naming system
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this naming system (computer friendly)
... title ΣT 0..1 string Title for this naming system (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... kind ΣC 1..1 code codesystem | identifier | root
Binding: Naming System Type (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 1..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... responsible T 0..1 string Who maintains system namespace?
... type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc
Binding: Naming System Identifier System Type (Preferred)
... description T 0..1 markdown Natural language description of the naming system
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this naming system is defined
... copyright T 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the NamingSystem is expected to be used
... topic XD 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..* ContactDetail Who authored the CodeSystem

... editor 0..* ContactDetail Who edited the NamingSystem

... reviewer 0..* ContactDetail Who reviewed the NamingSystem

... endorser 0..* ContactDetail Who endorsed the NamingSystem

... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

... usage T 0..1 string How/where is it used
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system

.... type ΣC 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: Naming System Identifier Type (Required)
.... value Σ 1..1 string The unique identifier
.... preferred C 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period C 0..1 Period When is identifier valid?
.... authoritative C 0..1 boolean Whether the identifier is authoritative

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

4.11.5.1 Terminology Bindings

Path ValueSet Type Documentation
NamingSystem.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
NamingSystem.status PublicationStatus Required

The lifecycle status of an artifact.
NamingSystem.kind NamingSystemType Required

Identifies the purpose of the naming system.
NamingSystem.type NamingSystemIdentifierSystemType (a valid code from identifierType icon) Preferred

Identifies the style of unique identifier used to identify a namespace.
NamingSystem.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
NamingSystem.topic DefinitionTopic Example

High-level categorization of the definition, used for searching, sorting, and filtering.
NamingSystem.uniqueId.type NamingSystemIdentifierType Required

Identifies the style of unique identifier used to identify a namespace.

4.11.5.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img nsd-1Rule (base)Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
img cnl-1Warning NamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img nsd-2Rule (base)Can't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
img nsd-3Rule (base)Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)uniqueId.where(authoritative = true).select(type.toString() & period.start.toString() & period.end.toString()).isDistinct()

4.11.5.3 Dealing with duplicate entries

In some cases, the same code or identifier system might accidentally be created more than once in a registry, for example because someone failed to check for an existing entry before adding a new one or if they didn't recognize that their addition replicates another. If this occurs, the system publisher should be contacted for guidance.

4.11.5.4 NamingSystem.url

The NamingSystem resource has a url property. The NamingSystem resource also specifies preferred identifiers for the Identifier or Code system that is being described. These are not the same thing; the url property of the NamingSystem itself identifies the registration of the system - the description itself, where as the preferred identifiers identify the system being described.

The NamingSystem.url SHOULD not be the same as a URL in the preferred identifiers list, and it would not therefore appear in a Coding.system or an Identifier.system.

4.11.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
contact string Name of an individual to contact NamingSystem.contact.name
context token A use context assigned to the naming system (NamingSystem.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the naming system (NamingSystem.useContext.value.ofType(Quantity)) | (NamingSystem.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the naming system NamingSystem.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the naming system On NamingSystem.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		 30 Resources
context-type-value composite A use context type and value assigned to the naming system On NamingSystem.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		 30 Resources
date date The naming system publication date NamingSystem.date 31 Resources
derived-from reference A resource that the NamingSystem is derived from NamingSystem.relatedArtifact.where(type='derived-from').resource
(Any)		 9 Resources
description string The description of the naming system NamingSystem.description 29 Resources
effective date The time during which the NamingSystem is intended to be in use NamingSystem.effectivePeriod 12 Resources
id-type token oid | uuid | uri | other NamingSystem.uniqueId.type
identifier token External identifier for the naming system NamingSystem.identifier 35 Resources
jurisdiction token Intended jurisdiction for the naming system NamingSystem.jurisdiction 27 Resources
kind token codesystem | identifier | root NamingSystem.kind
name string Computationally friendly name of the naming system NamingSystem.name 28 Resources
period date When is identifier valid? NamingSystem.uniqueId.period
predecessor reference The predecessor of the NamingSystem NamingSystem.relatedArtifact.where(type='predecessor').resource
(Any)		 9 Resources
publisher string Name of the publisher of the naming system NamingSystem.publisher 31 Resources
responsible string Who maintains system namespace? NamingSystem.responsible
status token The current status of the naming system NamingSystem.status 35 Resources
telecom token Contact details for individual or organization NamingSystem.contact.telecom
topic token Topics associated with the NamingSystem NamingSystem.topic 10 Resources
type token e.g. driver, provider, patient, bank etc. NamingSystem.type
url uri The uri that identifies the naming system NamingSystem.url 34 Resources
value string The unique identifier NamingSystem.uniqueId.value
version token The business version of the naming system NamingSystem.version 32 Resources