Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

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 TUDomainResourceSystem 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the naming system (business identifier)

... version Σ0..1stringBusiness version of the naming system
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this naming system (computer friendly)
... title ΣT0..1stringTitle for this naming system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... kind ΣC1..1codecodesystem | identifier | root
Binding: Naming System Type (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... responsible T0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc
Binding: Naming System Identifier System Type (Preferred)
... description T0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this naming system is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the NamingSystem was approved by publisher
... lastReviewDate 0..1dateWhen the NamingSystem was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the NamingSystem is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the CodeSystem

... editor 0..*ContactDetailWho edited the NamingSystem

... reviewer 0..*ContactDetailWho reviewed the NamingSystem

... endorser 0..*ContactDetailWho endorsed the NamingSystem

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc

... usage T0..1stringHow/where is it used
... uniqueId ΣC1..*BackboneElementUnique identifiers used for system

.... type ΣC1..1codeoid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: Naming System Identifier Type (Required)
.... value Σ1..1stringThe unique identifier
.... preferred C0..1booleanIs this the id that should be used for this type
.... comment 0..1stringNotes about identifier usage
.... period C0..1PeriodWhen is identifier valid?
.... authoritative C0..1booleanWhether the identifier is authoritative

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

NamingSystem (DomainResource) +MetadataResourceAn absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which NamingSystem is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the naming systemtitle : string [0..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] « null (Strength=Required)PublicationStatus! »Indicates the purpose for the naming system - what kinds of things does it make unique?kind : code [1..1] « null (Strength=Required)NamingSystemType! » « This element has or is affected by some invariantsC »A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the naming system was last significantly changed. The date must change 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 organization or individual responsible for the release and ongoing maintenance of 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] « null (Strength=Preferred)NamingSystemIdentifierSystemT...? »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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this naming system is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming systemcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the NamingSystem content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the NamingSystemauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the NamingSystemeditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystemreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etcusage : string [0..1]UniqueIdIdentifies the unique identifier scheme used for this particular identifiertype : code [1..1] « null (Strength=Required)NamingSystemIdentifierType! » « This element has or is affected by some invariantsC »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] « This element has or is affected by some invariantsC »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] « This element has or is affected by some invariantsC »Indicates whether this identifier ie endorsed by the official owner of the associated naming systemauthoritative : boolean [0..1] « This element has or is affected by some invariantsC »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 -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the naming system -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author>
 <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- I 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- I 0..1 Period When is identifier valid? --></period>
  <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative -->
 </uniqueId>
</NamingSystem>

JSON Template

{doco
  "resourceType" : "NamingSystem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the naming system (business identifier)
  "version" : "<string>", // Business version of the naming system
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this naming system (computer friendly)
  "title" : "<string>", // Title for this naming system (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  codesystem | identifier | root
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "responsible" : "<string>", // Who maintains system namespace?
  "type" : { CodeableConcept }, // e.g. driver,  provider,  patient, bank etc
  "description" : "<markdown>", // Natural language description of the naming system
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for naming system (if applicable)
  "purpose" : "<markdown>", // Why this naming system is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the NamingSystem is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the CodeSystem
  "editor" : [{ ContactDetail }], // Who edited the NamingSystem
  "reviewer" : [{ ContactDetail }], // Who reviewed the NamingSystem
  "endorser" : [{ ContactDetail }], // Who endorsed the NamingSystem
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "usage" : "<string>", // How/where is it used
  "uniqueId" : [{ // I R!  Unique identifiers used for system
    "type" : "<code>", // I R!  oid | uuid | uri | iri-stem | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // I Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // I When is identifier valid?
    "authoritative" : <boolean> // I Whether the identifier is authoritative
  }]
}

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:url [ uri ] ; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the naming system (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the naming system
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this naming system (computer friendly)
  fhir:title [ string ] ; # 0..1 Title for this naming system (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:kind [ code ] ; # 1..1 I codesystem | identifier | root
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 1..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:responsible [ string ] ; # 0..1 Who maintains system namespace?
  fhir:type [ CodeableConcept ] ; # 0..1 e.g. driver,  provider,  patient, bank etc
  fhir:description [ markdown ] ; # 0..1 Natural language description of the naming system
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this naming system is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the NamingSystem was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the NamingSystem was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the NamingSystem is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the CodeSystem
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the NamingSystem
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the NamingSystem
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the NamingSystem
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:usage [ string ] ; # 0..1 How/where is it used
  fhir:uniqueId ( [ # 1..* I Unique identifiers used for system
    fhir:type [ code ] ; # 1..1 I oid | uuid | uri | iri-stem | v2csmnemonic | other
    fhir:value [ string ] ; # 1..1 The unique identifier
    fhir:preferred [ boolean ] ; # 0..1 I Is this the id that should be used for this type
    fhir:comment [ string ] ; # 0..1 Notes about identifier usage
    fhir:period [ Period ] ; # 0..1 I When is identifier valid?
    fhir:authoritative [ boolean ] ; # 0..1 I Whether the identifier is authoritative
  ] ... ) ;
]

Changes from both R4 and R4B

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.versionAlgorithm[x]
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/identifier-type` (extensible)
NamingSystem.purpose
  • Added Element
NamingSystem.copyright
  • Added Element
NamingSystem.copyrightLabel
  • Added Element
NamingSystem.approvalDate
  • Added Element
NamingSystem.lastReviewDate
  • Added Element
NamingSystem.effectivePeriod
  • Added Element
NamingSystem.topic
  • Added Element
NamingSystem.author
  • Added Element
NamingSystem.editor
  • Added Element
NamingSystem.reviewer
  • Added Element
NamingSystem.endorser
  • Added Element
NamingSystem.relatedArtifact
  • Added Element
NamingSystem.uniqueId.type
  • Add codes iri-stem, v2csmnemonic
NamingSystem.uniqueId.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem TUDomainResourceSystem 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the naming system (business identifier)

... version Σ0..1stringBusiness version of the naming system
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this naming system (computer friendly)
... title ΣT0..1stringTitle for this naming system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... kind ΣC1..1codecodesystem | identifier | root
Binding: Naming System Type (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... responsible T0..1stringWho maintains system namespace?
... type 0..1CodeableConcepte.g. driver, provider, patient, bank etc
Binding: Naming System Identifier System Type (Preferred)
... description T0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this naming system is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the NamingSystem was approved by publisher
... lastReviewDate 0..1dateWhen the NamingSystem was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the NamingSystem is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the CodeSystem

... editor 0..*ContactDetailWho edited the NamingSystem

... reviewer 0..*ContactDetailWho reviewed the NamingSystem

... endorser 0..*ContactDetailWho endorsed the NamingSystem

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc

... usage T0..1stringHow/where is it used
... uniqueId ΣC1..*BackboneElementUnique identifiers used for system

.... type ΣC1..1codeoid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: Naming System Identifier Type (Required)
.... value Σ1..1stringThe unique identifier
.... preferred C0..1booleanIs this the id that should be used for this type
.... comment 0..1stringNotes about identifier usage
.... period C0..1PeriodWhen is identifier valid?
.... authoritative C0..1booleanWhether the identifier is authoritative

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

NamingSystem (DomainResource) +MetadataResourceAn absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which NamingSystem is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the naming systemtitle : string [0..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] « null (Strength=Required)PublicationStatus! »Indicates the purpose for the naming system - what kinds of things does it make unique?kind : code [1..1] « null (Strength=Required)NamingSystemType! » « This element has or is affected by some invariantsC »A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the naming system was last significantly changed. The date must change 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 organization or individual responsible for the release and ongoing maintenance of 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] « null (Strength=Preferred)NamingSystemIdentifierSystemT...? »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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this naming system is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming systemcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the NamingSystem content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the NamingSystemauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the NamingSystemeditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystemreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etcusage : string [0..1]UniqueIdIdentifies the unique identifier scheme used for this particular identifiertype : code [1..1] « null (Strength=Required)NamingSystemIdentifierType! » « This element has or is affected by some invariantsC »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] « This element has or is affected by some invariantsC »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] « This element has or is affected by some invariantsC »Indicates whether this identifier ie endorsed by the official owner of the associated naming systemauthoritative : boolean [0..1] « This element has or is affected by some invariantsC »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 -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the naming system -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author>
 <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- I 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- I 0..1 Period When is identifier valid? --></period>
  <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative -->
 </uniqueId>
</NamingSystem>

JSON Template

{doco
  "resourceType" : "NamingSystem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the naming system (business identifier)
  "version" : "<string>", // Business version of the naming system
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this naming system (computer friendly)
  "title" : "<string>", // Title for this naming system (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  codesystem | identifier | root
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "responsible" : "<string>", // Who maintains system namespace?
  "type" : { CodeableConcept }, // e.g. driver,  provider,  patient, bank etc
  "description" : "<markdown>", // Natural language description of the naming system
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for naming system (if applicable)
  "purpose" : "<markdown>", // Why this naming system is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the NamingSystem is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the CodeSystem
  "editor" : [{ ContactDetail }], // Who edited the NamingSystem
  "reviewer" : [{ ContactDetail }], // Who reviewed the NamingSystem
  "endorser" : [{ ContactDetail }], // Who endorsed the NamingSystem
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "usage" : "<string>", // How/where is it used
  "uniqueId" : [{ // I R!  Unique identifiers used for system
    "type" : "<code>", // I R!  oid | uuid | uri | iri-stem | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // I Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // I When is identifier valid?
    "authoritative" : <boolean> // I Whether the identifier is authoritative
  }]
}

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:url [ uri ] ; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the naming system (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the naming system
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this naming system (computer friendly)
  fhir:title [ string ] ; # 0..1 Title for this naming system (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:kind [ code ] ; # 1..1 I codesystem | identifier | root
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 1..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:responsible [ string ] ; # 0..1 Who maintains system namespace?
  fhir:type [ CodeableConcept ] ; # 0..1 e.g. driver,  provider,  patient, bank etc
  fhir:description [ markdown ] ; # 0..1 Natural language description of the naming system
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this naming system is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the NamingSystem was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the NamingSystem was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the NamingSystem is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the CodeSystem
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the NamingSystem
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the NamingSystem
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the NamingSystem
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:usage [ string ] ; # 0..1 How/where is it used
  fhir:uniqueId ( [ # 1..* I Unique identifiers used for system
    fhir:type [ code ] ; # 1..1 I oid | uuid | uri | iri-stem | v2csmnemonic | other
    fhir:value [ string ] ; # 1..1 The unique identifier
    fhir:preferred [ boolean ] ; # 0..1 I Is this the id that should be used for this type
    fhir:comment [ string ] ; # 0..1 Notes about identifier usage
    fhir:period [ Period ] ; # 0..1 I When is identifier valid?
    fhir:authoritative [ boolean ] ; # 0..1 I Whether the identifier is authoritative
  ] ... ) ;
]

Changes from both R4 and R4B

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.versionAlgorithm[x]
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/identifier-type` (extensible)
NamingSystem.purpose
  • Added Element
NamingSystem.copyright
  • Added Element
NamingSystem.copyrightLabel
  • Added Element
NamingSystem.approvalDate
  • Added Element
NamingSystem.lastReviewDate
  • Added Element
NamingSystem.effectivePeriod
  • Added Element
NamingSystem.topic
  • Added Element
NamingSystem.author
  • Added Element
NamingSystem.editor
  • Added Element
NamingSystem.reviewer
  • Added Element
NamingSystem.endorser
  • Added Element
NamingSystem.relatedArtifact
  • Added Element
NamingSystem.uniqueId.type
  • Add codes iri-stem, v2csmnemonic
NamingSystem.uniqueId.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

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

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

NameTypeDescriptionExpressionIn Common
contactstringName of an individual to contactNamingSystem.contact.name
contexttokenA use context assigned to the naming system(NamingSystem.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the naming system(NamingSystem.useContext.value.ofType(Quantity)) | (NamingSystem.useContext.value.ofType(Range))30 Resources
context-typetokenA type of use context assigned to the naming systemNamingSystem.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the naming systemOn NamingSystem.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		30 Resources
context-type-valuecompositeA use context type and value assigned to the naming systemOn NamingSystem.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		30 Resources
datedateThe naming system publication dateNamingSystem.date30 Resources
derived-fromreferenceA resource that the NamingSystem is derived fromNamingSystem.relatedArtifact.where(type='derived-from').resource
(Any)		10 Resources
descriptionstringThe description of the naming systemNamingSystem.description28 Resources
effectivedateThe time during which the NamingSystem is intended to be in useNamingSystem.effectivePeriod12 Resources
id-typetokenoid | uuid | uri | otherNamingSystem.uniqueId.type
identifiertokenExternal identifier for the naming systemNamingSystem.identifier34 Resources
jurisdictiontokenIntended jurisdiction for the naming systemNamingSystem.jurisdiction26 Resources
kindtokencodesystem | identifier | rootNamingSystem.kind
namestringComputationally friendly name of the naming systemNamingSystem.name26 Resources
perioddateWhen is identifier valid?NamingSystem.uniqueId.period
predecessorreferenceThe predecessor of the NamingSystemNamingSystem.relatedArtifact.where(type='predecessor').resource
(Any)		10 Resources
publisherstringName of the publisher of the naming systemNamingSystem.publisher30 Resources
responsiblestringWho maintains system namespace?NamingSystem.responsible
statustokenThe current status of the naming systemNamingSystem.status35 Resources
telecomtokenContact details for individual or organizationNamingSystem.contact.telecom
topictokenTopics associated with the NamingSystemNamingSystem.topic10 Resources
typetokene.g. driver, provider, patient, bank etc.NamingSystem.type
urluriThe uri that identifies the naming systemNamingSystem.url34 Resources
valuestringThe unique identifierNamingSystem.uniqueId.value
versiontokenThe business version of the naming systemNamingSystem.version30 Resources