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 Resource NamingSystem - Content

FHIR Infrastructure Work GroupMaturity Level: 1Compartments: Not linked to any 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.

6.26.1 Scope and Usage

Defines a specific code system or identifier system

6.26.2 Background and Context

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

6.26.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem IDomainResourceSystem of unique identification
Can't have more than one preferred identifier for a type
Can only have replacedBy if naming system is retired
Root systems cannot have uuid identifiers
... name 1..1stringHuman-readable label
... status ?!1..1codedraft | active | retired
ConformanceResourceStatus (Required)
... kind 1..1codecodesystem | identifier | root
NamingSystemType (Required)
... date Σ1..1dateTimePublication Date(/time)
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... responsible 0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc.
Identifier Type Codes (Extensible)
... description 0..1stringWhat does naming system identify?
... useContext Σ0..*CodeableConceptContent intends to support these contexts
Context of Use ValueSet (Extensible)
... usage 0..1stringHow/where is it used
... uniqueId 1..*BackboneElementUnique identifiers used for system
.... type 1..1codeoid | uuid | uri | other
NamingSystemIdentifierType (Required)
.... value 1..1stringThe unique identifier
.... preferred 0..1booleanIs this the id that should be used for this type
.... period 0..1PeriodWhen is identifier valid?
... replacedBy I0..1Reference(NamingSystem)Use this instead

doco Documentation for this format

UML Diagram

NamingSystem (DomainResource)The descriptive name of this particular identifier type or code systemname : string [1..1]Indicates whether the naming system is "ready for use" or not (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)ConformanceResourceStatus! »Indicates the purpose for the naming system - what kinds of things does it make unique?kind : code [1..1] « Identifies the purpose of the naming system. (Strength=Required)NamingSystemType! »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 changesdate : dateTime [1..1]The name of the individual or organization that published the naming systempublisher : string [0..1]The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collisionresponsible : string [0..1]Categorizes a naming system for easier search by grouping related naming systemstype : CodeableConcept [0..1] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible)Identifier Type + »Details about what the namespace identifies including scope, granularity, version labeling, etcdescription : string [0..1]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 systemsuseContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible)Context of Use ValueSet+ »Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etcusage : string [0..1]For naming systems that are retired, indicates the naming system that should be used in their place (if any)replacedBy : Reference [0..1] « NamingSystem »ContactThe name of an individual to contact regarding the naming systemname : string [0..1]Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]UniqueIdIdentifies the unique identifier scheme used for this particular identifiertype : code [1..1] « Identifies the style of unique identifier used to identify a namespace. (Strength=Required)NamingSystemIdentifierType! »The string that should be sent over the wire to identify the code system or identifier systemvalue : string [1..1]Indicates whether this identifier is the "preferred" identifier of this typepreferred : boolean [0..1]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-deterministicperiod : Period [0..1]Contacts to assist a user in finding and communicating with the publishercontact[0..*]Indicates how the system may be identified when referenced in electronic exchangeuniqueId[1..*]

XML Template

<NamingSystem xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <name value="[string]"/><!-- 1..1 Human-readable label -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <kind value="[code]"/><!-- 1..1 codesystem | identifier | root -->
 <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? -->
 <type><!-- 0..1 CodeableConcept e.g. driver,  provider,  patient, bank etc. --></type>
 <description value="[string]"/><!-- 0..1 What does naming system identify? -->
 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- 1..1 oid | uuid | uri | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type -->
  <period><!-- 0..1 Period When is identifier valid? --></period>
 </uniqueId>
 <replacedBy><!-- ?? 0..1 Reference(NamingSystem) Use this instead --></replacedBy>
</NamingSystem>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem IDomainResourceSystem of unique identification
Can't have more than one preferred identifier for a type
Can only have replacedBy if naming system is retired
Root systems cannot have uuid identifiers
... name 1..1stringHuman-readable label
... status ?!1..1codedraft | active | retired
ConformanceResourceStatus (Required)
... kind 1..1codecodesystem | identifier | root
NamingSystemType (Required)
... date Σ1..1dateTimePublication Date(/time)
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... responsible 0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc.
Identifier Type Codes (Extensible)
... description 0..1stringWhat does naming system identify?
... useContext Σ0..*CodeableConceptContent intends to support these contexts
Context of Use ValueSet (Extensible)
... usage 0..1stringHow/where is it used
... uniqueId 1..*BackboneElementUnique identifiers used for system
.... type 1..1codeoid | uuid | uri | other
NamingSystemIdentifierType (Required)
.... value 1..1stringThe unique identifier
.... preferred 0..1booleanIs this the id that should be used for this type
.... period 0..1PeriodWhen is identifier valid?
... replacedBy I0..1Reference(NamingSystem)Use this instead

doco Documentation for this format

UML Diagram

NamingSystem (DomainResource)The descriptive name of this particular identifier type or code systemname : string [1..1]Indicates whether the naming system is "ready for use" or not (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)ConformanceResourceStatus! »Indicates the purpose for the naming system - what kinds of things does it make unique?kind : code [1..1] « Identifies the purpose of the naming system. (Strength=Required)NamingSystemType! »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 changesdate : dateTime [1..1]The name of the individual or organization that published the naming systempublisher : string [0..1]The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collisionresponsible : string [0..1]Categorizes a naming system for easier search by grouping related naming systemstype : CodeableConcept [0..1] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible)Identifier Type + »Details about what the namespace identifies including scope, granularity, version labeling, etcdescription : string [0..1]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 systemsuseContext : CodeableConcept [0..*] « Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Strength=Extensible)Context of Use ValueSet+ »Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etcusage : string [0..1]For naming systems that are retired, indicates the naming system that should be used in their place (if any)replacedBy : Reference [0..1] « NamingSystem »ContactThe name of an individual to contact regarding the naming systemname : string [0..1]Contact details for individual (if a name was provided) or the publishertelecom : ContactPoint [0..*]UniqueIdIdentifies the unique identifier scheme used for this particular identifiertype : code [1..1] « Identifies the style of unique identifier used to identify a namespace. (Strength=Required)NamingSystemIdentifierType! »The string that should be sent over the wire to identify the code system or identifier systemvalue : string [1..1]Indicates whether this identifier is the "preferred" identifier of this typepreferred : boolean [0..1]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-deterministicperiod : Period [0..1]Contacts to assist a user in finding and communicating with the publishercontact[0..*]Indicates how the system may be identified when referenced in electronic exchangeuniqueId[1..*]

XML Template

<NamingSystem xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <name value="[string]"/><!-- 1..1 Human-readable label -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <kind value="[code]"/><!-- 1..1 codesystem | identifier | root -->
 <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact>  <!-- 0..* Contact details of the publisher -->
  <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
  <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom>
 </contact>
 <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? -->
 <type><!-- 0..1 CodeableConcept e.g. driver,  provider,  patient, bank etc. --></type>
 <description value="[string]"/><!-- 0..1 What does naming system identify? -->
 <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- 1..1 oid | uuid | uri | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type -->
  <period><!-- 0..1 Period When is identifier valid? --></period>
 </uniqueId>
 <replacedBy><!-- ?? 0..1 Reference(NamingSystem) Use this instead --></replacedBy>
</NamingSystem>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

6.26.3.1 Terminology Bindings

PathDefinitionTypeReference
NamingSystem.status The lifecycle status of a Value Set or Concept Map.RequiredConformanceResourceStatus
NamingSystem.kind Identifies the purpose of the naming system.RequiredNamingSystemType
NamingSystem.type A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.ExtensibleIdentifier Type Codes
NamingSystem.useContext Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.ExtensibleContext of Use ValueSet
NamingSystem.uniqueId.type Identifies the style of unique identifier used to identify a namespace.RequiredNamingSystemIdentifierType

6.26.3.2 Constraints

  • nsd-1: Root systems cannot have uuid identifiers (expression: kind != 'root' or uniqueId.type = 'uuid')
  • nsd-2: Can't have more than one preferred identifier for a type (expression: uniqueId.where(preferred = true).select(type).distinct())
  • nsd-3: Can only have replacedBy if naming system is retired (expression: replacedBy.empty() or status = 'retired')

6.26.3.3 Dealing with duplicate entries

In some cases, the same code or identifier system might accidentally get created more than once in a registry (perhaps because someone failed to check for an existing entry before adding a new one or knows the same concept with a different name. If this occurs, one of the system entries should be deleted and the remaining entry should have its information updated to include any identifiers present on the original entry (and possibly have its descriptive information modified to include additional information gleaned from the duplicate entry).

6.26.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
contactstringName of an individual to contactNamingSystem.contact.name
contexttokenContent intends to support these contextsNamingSystem.useContext
datedatePublication Date(/time)NamingSystem.date
id-typetokenoid | uuid | uri | otherNamingSystem.uniqueId.type
kindtokencodesystem | identifier | rootNamingSystem.kind
namestringHuman-readable labelNamingSystem.name
perioddateWhen is identifier valid?NamingSystem.uniqueId.period
publisherstringName of the publisher (Organization or individual)NamingSystem.publisher
replaced-byreferenceUse this insteadNamingSystem.replacedBy
(NamingSystem)
responsiblestringWho maintains system namespace?NamingSystem.responsible
statustokendraft | active | retiredNamingSystem.status
telecomtokenContact details for individual or publisherNamingSystem.contact.telecom
typetokene.g. driver, provider, patient, bank etc.NamingSystem.type
valuestringThe unique identifierNamingSystem.uniqueId.value