Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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.11 Resource NamingSystem - Content

Vocabulary Work GroupMaturity Level: 2 Trial UseSecurity Category: Anonymous Compartments: 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.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 .

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

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
... name ΣC1..1stringName for this naming system (computer friendly)
... title Σ0..1stringTitle for this naming system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind Σ1..1codecodesystem | identifier | root
NamingSystemType (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (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.
NamingSystemIdentifierSystemType (Preferred)
... description 0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Jurisdiction (Extensible)

... purpose 0..1markdownWhy this naming system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the NamingSystem was approved by publisher
... lastReviewDate 0..1dateWhen the NamingSystem was last reviewed
... effectivePeriod Σ0..1PeriodWhen the NamingSystem is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (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 0..1stringHow/where is it used
... uniqueId Σ1..*BackboneElementUnique identifiers used for system

.... type Σ1..1codeoid | uuid | uri | v2csmnemonic | other
NamingSystemIdentifierType (Required)
.... value Σ1..1stringThe unique identifier
.... preferred C0..1booleanIs this the id that should be used for this type
+ Rule: Can't have more than one preferred identifier for a type
.... comment 0..1stringNotes about identifier usage
.... period 0..1PeriodWhen is identifier valid?
.... authoritative C0..1booleanWhether the identifier is authoritative
+ 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)

doco Documentation for this format

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]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! »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 published. 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)Jurisdiction ValueSet+ »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]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 primarily responsible for review of some aspect of the NamingSystemreviewer : ContactDetail [0..*]An individual or organization 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! »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 whether this identifier ie endorsed by the official owner of the associated naming systemauthoritative : boolean [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 -->
 <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 -->
 <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]"/><!-- 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 -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed -->
 <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>  <!-- 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- 1..1 oid | uuid | uri | v2csmnemonic | 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>
  <authoritative value="[boolean]"/><!-- 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
  "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>", // 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
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed
  "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" : [{ // R!  Unique identifiers used for system
    "type" : "<code>", // R!  oid | uuid | uri | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // When is identifier valid?
    "authoritative" : <boolean> // 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:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique)
  fhir:NamingSystem.identifier [ Identifier ], ... ; # 0..* Additional identifier for the naming system (business identifier)
  fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system
  fhir:NamingSystem.name [ string ]; # 1..1 I Name for this naming system (computer friendly)
  fhir:NamingSystem.title [ string ]; # 0..1 Title for this naming system (human friendly)
  fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root
  fhir:NamingSystem.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed
  fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher/steward (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..* The context that the content is intended to support
  fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:NamingSystem.purpose [ markdown ]; # 0..1 Why this naming system is defined
  fhir:NamingSystem.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:NamingSystem.approvalDate [ date ]; # 0..1 When the NamingSystem was approved by publisher
  fhir:NamingSystem.lastReviewDate [ date ]; # 0..1 When the NamingSystem was last reviewed
  fhir:NamingSystem.effectivePeriod [ Period ]; # 0..1 When the NamingSystem is expected to be used
  fhir:NamingSystem.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:NamingSystem.author [ ContactDetail ], ... ; # 0..* Who authored the CodeSystem
  fhir:NamingSystem.editor [ ContactDetail ], ... ; # 0..* Who edited the NamingSystem
  fhir:NamingSystem.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the NamingSystem
  fhir:NamingSystem.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the NamingSystem
  fhir:NamingSystem.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  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 | v2csmnemonic | 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.uniqueId.authoritative [ boolean ]; # 0..1 Whether the identifier is authoritative
  ], ...;
]

Changes since R4

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.type
  • Remove Binding http://hl7.org/fhir/ValueSet/identifier-type (extensible)
  • Remove Binding http://hl7.org/fhir/ValueSet/identifier-type (extensible)
NamingSystem.purpose
  • Added Element
NamingSystem.copyright
  • 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.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors).)

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

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
... name ΣC1..1stringName for this naming system (computer friendly)
... title Σ0..1stringTitle for this naming system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind Σ1..1codecodesystem | identifier | root
NamingSystemType (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (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.
NamingSystemIdentifierSystemType (Preferred)
... description 0..1markdownNatural language description of the naming system
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for naming system (if applicable)
Jurisdiction (Extensible)

... purpose 0..1markdownWhy this naming system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the NamingSystem was approved by publisher
... lastReviewDate 0..1dateWhen the NamingSystem was last reviewed
... effectivePeriod Σ0..1PeriodWhen the NamingSystem is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (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 0..1stringHow/where is it used
... uniqueId Σ1..*BackboneElementUnique identifiers used for system

.... type Σ1..1codeoid | uuid | uri | v2csmnemonic | other
NamingSystemIdentifierType (Required)
.... value Σ1..1stringThe unique identifier
.... preferred C0..1booleanIs this the id that should be used for this type
+ Rule: Can't have more than one preferred identifier for a type
.... comment 0..1stringNotes about identifier usage
.... period 0..1PeriodWhen is identifier valid?
.... authoritative C0..1booleanWhether the identifier is authoritative
+ 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)

doco Documentation for this format

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]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! »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 published. 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)Jurisdiction ValueSet+ »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]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 primarily responsible for review of some aspect of the NamingSystemreviewer : ContactDetail [0..*]An individual or organization 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! »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 whether this identifier ie endorsed by the official owner of the associated naming systemauthoritative : boolean [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 -->
 <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 -->
 <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]"/><!-- 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 -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed -->
 <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>  <!-- 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- 1..1 oid | uuid | uri | v2csmnemonic | 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>
  <authoritative value="[boolean]"/><!-- 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
  "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>", // 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
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed
  "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" : [{ // R!  Unique identifiers used for system
    "type" : "<code>", // R!  oid | uuid | uri | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // When is identifier valid?
    "authoritative" : <boolean> // 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:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique)
  fhir:NamingSystem.identifier [ Identifier ], ... ; # 0..* Additional identifier for the naming system (business identifier)
  fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system
  fhir:NamingSystem.name [ string ]; # 1..1 I Name for this naming system (computer friendly)
  fhir:NamingSystem.title [ string ]; # 0..1 Title for this naming system (human friendly)
  fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root
  fhir:NamingSystem.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed
  fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher/steward (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..* The context that the content is intended to support
  fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable)
  fhir:NamingSystem.purpose [ markdown ]; # 0..1 Why this naming system is defined
  fhir:NamingSystem.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:NamingSystem.approvalDate [ date ]; # 0..1 When the NamingSystem was approved by publisher
  fhir:NamingSystem.lastReviewDate [ date ]; # 0..1 When the NamingSystem was last reviewed
  fhir:NamingSystem.effectivePeriod [ Period ]; # 0..1 When the NamingSystem is expected to be used
  fhir:NamingSystem.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:NamingSystem.author [ ContactDetail ], ... ; # 0..* Who authored the CodeSystem
  fhir:NamingSystem.editor [ ContactDetail ], ... ; # 0..* Who edited the NamingSystem
  fhir:NamingSystem.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the NamingSystem
  fhir:NamingSystem.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the NamingSystem
  fhir:NamingSystem.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  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 | v2csmnemonic | 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.uniqueId.authoritative [ boolean ]; # 0..1 Whether the identifier is authoritative
  ], ...;
]

Changes since Release 4

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.type
  • Remove Binding http://hl7.org/fhir/ValueSet/identifier-type (extensible)
  • Remove Binding http://hl7.org/fhir/ValueSet/identifier-type (extensible)
NamingSystem.purpose
  • Added Element
NamingSystem.copyright
  • 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.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors).)

 

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

PathDefinitionTypeReference
NamingSystem.status

The lifecycle status of an artifact.

RequiredPublicationStatus
NamingSystem.kind

Identifies the purpose of the naming system.

RequiredNamingSystemType
NamingSystem.type

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

PreferredNamingSystemIdentifierSystemType
NamingSystem.jurisdiction

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 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) .

ExtensibleJurisdiction ValueSet
NamingSystem.topic

High-level categorization of the definition, used for searching, sorting, and filtering.

ExampleDefinitionTopic
NamingSystem.uniqueId.type

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

RequiredNamingSystemIdentifierType

4.11.5.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
 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}')
 nsd-1Rule (base)Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
 cnl-1Warning NamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
 nsd-2Rule NamingSystem.uniqueId.preferredCan't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
 nsd-3Rule NamingSystem.uniqueId.authoritativeCan'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).isDistinct().select(period).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 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.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. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contact NstringName of an individual to contactNamingSystem.contact.name
contexttokenA use context assigned to the naming system(NamingSystem.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the naming system(NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range)
context-typetokenA type of use context assigned to the naming systemNamingSystem.useContext.code
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)
context-type-valuecompositeA use context type and value assigned to the naming systemOn NamingSystem.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
date NdateThe naming system publication dateNamingSystem.date
derived-fromreferenceA resource that the NamingSystem is derived fromNamingSystem.relatedArtifact.where(type='derived-from').resource
(Any)
description NstringThe description of the naming systemNamingSystem.description
effectivedateThe time during which the NamingSystem is intended to be in useNamingSystem.effectivePeriod
id-type Ntokenoid | uuid | uri | otherNamingSystem.uniqueId.type
identifiertokenExternal identifier for the naming systemNamingSystem.identifier
jurisdictiontokenIntended jurisdiction for the naming systemNamingSystem.jurisdiction
kind Ntokencodesystem | identifier | rootNamingSystem.kind
name NstringComputationally friendly name of the naming systemNamingSystem.name
perioddateWhen is identifier valid?NamingSystem.uniqueId.period
predecessorreferenceThe predecessor of the NamingSystemNamingSystem.relatedArtifact.where(type='predecessor').resource
(Any)
publisher NstringName of the publisher of the naming systemNamingSystem.publisher
responsible NstringWho maintains system namespace?NamingSystem.responsible
status NtokenThe current status of the naming systemNamingSystem.status
telecomtokenContact details for individual or organizationNamingSystem.contact.telecom
topictokenTopics associated with the NamingSystemNamingSystem.topic
typetokene.g. driver, provider, patient, bank etc.NamingSystem.type
url NuriThe uri that identifies the naming systemNamingSystem.url
value NstringThe unique identifierNamingSystem.uniqueId.value
version NtokenThe business version of the naming systemNamingSystem.version