FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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

4.10 Resource NamingSystem - Content

FHIR Infrastructure Work GroupMaturity Level: 1 Trial UseCompartments: 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.

4.10.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.10.2 Boundaries and Relationships

The CodeSystem resource defines the content of a code system, and also its preferred identifier. The NamingSystem resource identifies the existence of a code or identifier system, and its possible and preferred identifiers. The key difference between the resources is who creates and manages them - CodeSystem resources are managed by the owner of the code system resource, who can properly define the features and content of the code system. NamingSystem resources, on the other hand, are frequently defined by 3rd parties that encounter the code system in use, and need to describe the use, but do not have the authority to define the features and content. Additionally, there may be multiple authoritative NamingSystem resources for a code system, but there should only be one CodeSystem resource.

4.10.3 Background and Context

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

4.10.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem IDomainResourceSystem of unique identification
+ Root systems cannot have uuid identifiers
+ Can only have replacedBy if naming system is retired
+ Can't have more than one preferred identifier for a type
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... name Σ1..1stringName for this naming system (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind 1..1codecodesystem | identifier | root
NamingSystemType (Required)
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... responsible 0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc.
Identifier Type Codes (Extensible)
... description 0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Jurisdiction 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
.... comment 0..1stringNotes about identifier usage
.... period 0..1PeriodWhen is identifier valid?
... replacedBy I0..1Reference(NamingSystem)Use this instead

doco Documentation for this format

UML Diagram (Legend)

NamingSystem (DomainResource)A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this naming system. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! 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 naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changesdate : dateTime [1..1]The name of the individual or organization that published the naming systempublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]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 + A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etcdescription : markdown [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 for appropriate naming system instancesuseContext : UsageContext [0..*]A legal or geographic region in which the naming system is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction 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 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]Notes about the past or intended usage of this identifiercomment : string [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]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 Name for this naming system (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- 1..1 codesystem | identifier | root -->
 <date value="[dateTime]"/><!-- 1..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? -->
 <type><!-- 0..1 CodeableConcept e.g. driver,  provider,  patient, bank etc. --></type>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction>
 <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 -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- 0..1 Period When is identifier valid? --></period>
 </uniqueId>
 <replacedBy><!-- ?? 0..1 Reference(NamingSystem) Use this instead --></replacedBy>
</NamingSystem>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:NamingSystem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:NamingSystem.name [ string ]; # 1..1 Name for this naming system (computer friendly)
  fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root
  fhir:NamingSystem.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace?
  fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver,  provider,  patient, bank etc.
  fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system
  fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used
  fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system
    fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | other
    fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier
    fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type
    fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage
    fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid?
  ], ...;
  fhir:NamingSystem.replacedBy [ Reference(NamingSystem) ]; # 0..1 Use this instead
]

Changes since DSTU2

NamingSystem
NamingSystem.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
NamingSystem.contact
  • Type changed from BackboneElement to ContactDetail
NamingSystem.description
  • Type changed from string to markdown
NamingSystem.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
NamingSystem.jurisdiction
  • Added Element
NamingSystem.uniqueId.comment
  • Added Element
NamingSystem.contact.name
  • deleted
NamingSystem.contact.telecom
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem IDomainResourceSystem of unique identification
+ Root systems cannot have uuid identifiers
+ Can only have replacedBy if naming system is retired
+ Can't have more than one preferred identifier for a type
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... name Σ1..1stringName for this naming system (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind 1..1codecodesystem | identifier | root
NamingSystemType (Required)
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... responsible 0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc.
Identifier Type Codes (Extensible)
... description 0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Jurisdiction 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
.... comment 0..1stringNotes about identifier usage
.... period 0..1PeriodWhen is identifier valid?
... replacedBy I0..1Reference(NamingSystem)Use this instead

doco Documentation for this format

UML Diagram (Legend)

NamingSystem (DomainResource)A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this naming system. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! 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 naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changesdate : dateTime [1..1]The name of the individual or organization that published the naming systempublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]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 + A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etcdescription : markdown [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 for appropriate naming system instancesuseContext : UsageContext [0..*]A legal or geographic region in which the naming system is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction 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 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]Notes about the past or intended usage of this identifiercomment : string [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]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 Name for this naming system (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- 1..1 codesystem | identifier | root -->
 <date value="[dateTime]"/><!-- 1..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? -->
 <type><!-- 0..1 CodeableConcept e.g. driver,  provider,  patient, bank etc. --></type>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction>
 <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 -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- 0..1 Period When is identifier valid? --></period>
 </uniqueId>
 <replacedBy><!-- ?? 0..1 Reference(NamingSystem) Use this instead --></replacedBy>
</NamingSystem>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:NamingSystem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:NamingSystem.name [ string ]; # 1..1 Name for this naming system (computer friendly)
  fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root
  fhir:NamingSystem.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace?
  fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver,  provider,  patient, bank etc.
  fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system
  fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used
  fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system
    fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | other
    fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier
    fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type
    fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage
    fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid?
  ], ...;
  fhir:NamingSystem.replacedBy [ Reference(NamingSystem) ]; # 0..1 Use this instead
]

Changes since DSTU2

NamingSystem
NamingSystem.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
NamingSystem.contact
  • Type changed from BackboneElement to ContactDetail
NamingSystem.description
  • Type changed from string to markdown
NamingSystem.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
NamingSystem.jurisdiction
  • Added Element
NamingSystem.uniqueId.comment
  • Added Element
NamingSystem.contact.name
  • deleted
NamingSystem.contact.telecom
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

4.10.4.1 Terminology Bindings

PathDefinitionTypeReference
NamingSystem.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
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.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
NamingSystem.uniqueId.type Identifies the style of unique identifier used to identify a namespace.RequiredNamingSystemIdentifierType

4.10.4.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).isDistinct())
  • nsd-3: Can only have replacedBy if naming system is retired (expression : replacedBy.empty() or status = 'retired')

4.10.4.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 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 uniqueId updated to include any identifiers present on the original entry (and possibly have its descriptive information modified to include additional information from the duplicate entry).

4.10.5 Search Parameters

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

NameTypeDescriptionExpressionIn Common
contactstringName of an individual to contactNamingSystem.contact.name
datedateThe naming system publication dateNamingSystem.date
descriptionstringThe description of the naming systemNamingSystem.description
id-typetokenoid | uuid | uri | otherNamingSystem.uniqueId.type
jurisdictiontokenIntended jurisdiction for the naming systemNamingSystem.jurisdiction
kindtokencodesystem | identifier | rootNamingSystem.kind
namestringComputationally friendly name of the naming systemNamingSystem.name
perioddateWhen is identifier valid?NamingSystem.uniqueId.period
publisherstringName of the publisher of the naming systemNamingSystem.publisher
replaced-byreferenceUse this insteadNamingSystem.replacedBy
(NamingSystem)
responsiblestringWho maintains system namespace?NamingSystem.responsible
statustokenThe current status of the naming systemNamingSystem.status
telecomtokenContact details for individual or organizationNamingSystem.contact.telecom
typetokene.g. driver, provider, patient, bank etc.NamingSystem.type
valuestringThe unique identifierNamingSystem.uniqueId.value