Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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 icon Work Group Maturity Level : 2   Trial Use Security 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

The A CodeSystem NamingSystem resource defines the content manages identifiers of a code system or identifier system, identifier metadata (e.g. type), and also its preferred identifier. The limited code system or identifier system specific metadata (e.g. publisher and description). A NamingSystem CodeSystem resource identifies the existence of represents a code or identifier system, and its possible key properties, and preferred identifiers. The may include the content, identifiers, and other metadata. There is known overlap between the CodeSystem and NamingSystem resource elements. However, the key difference differences between the resources is who creates and manages them - are as follows:

  • CodeSystem resources are managed by the owner of the code system resource, who can properly define may include the features concept and property content of the code system. system, whereas NamingSystem resources, on the other hand, are frequently defined by 3rd parties that encounter the code system in use, and need to describe the use, but resources do not have the authority not. CodeSystem resources also allow identifiers to define the features and content. Additionally, there may be multiple authoritative supplemented by specific metadata. The metadata are supported with extensions.
  • NamingSystem resources allow the identifiers for a code system, but there should only systems or identifier systems to be one CodeSystem resource. 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 resources refer to references for this resource directly. This resource does not implement any patterns. Resource.

4.11.5 Resource Content

Structure

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . NamingSystem TU DomainResource System of unique identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Root systems cannot have uuid identifiers
+ Rule: Can't have more than one preferred identifier for a type
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the naming system (business identifier)

... version Σ 0..1 string Business version of the naming system
... name Σ C 1..1 string Name for this naming system (computer friendly)
... title Σ T 1..1 0..1 string Name Title for this naming system (computer (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . kind Σ 1..1 code codesystem | identifier | root
NamingSystemType ( Required )
. . . date experimental Σ 1..1 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

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

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

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

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

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

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

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

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

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

. . . . type Σ 1..1 code oid | uuid | uri | v2csmnemonic | other
NamingSystemIdentifierType ( Required )
. . . . value Σ 1..1 string The unique identifier
. . . . preferred C 0..1 boolean Is this the id that should be used for this type
+ Rule: Can't have more than one preferred identifier for a type
. . . . comment 0..1 string Notes about identifier usage
. . . . period 0..1 Period When is identifier valid?
. . . . authoritative C 0..1 boolean Whether 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

NamingSystem ( DomainResource ) + MetadataResource An 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 servers url : 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 instance identifier : 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 sequence version : 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 generation name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the naming system title : 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 usage experimental : boolean [0..1] The date (and optionally time) when the naming system was published. 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 changes date : dateTime [1..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the naming system publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision responsible : string [0..1] Categorizes a naming system for easier search by grouping related naming systems type : CodeableConcept [0..1] « null (Strength=Extensible) (Strength=Preferred) Identifier Type 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, etc description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the naming system is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this naming system is needed and why it has been designed as it has purpose : 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 system copyright : 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 usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the NamingSystem content was or is planned to be in active use effectivePeriod : 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 searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the NamingSystem author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the NamingSystem editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the NamingSystem reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the NamingSystem for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*] Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc usage : string [0..1] UniqueId Identifies the unique identifier scheme used for this particular identifier type : code [1..1] « null (Strength=Required) NamingSystemIdentifierType ! » The string that should be sent over the wire to identify the code system or identifier system value : string [1..1] Indicates whether this identifier is the "preferred" identifier of this type preferred : boolean [0..1] Notes about the past or intended usage of this identifier comment : 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-deterministic period : Period [0..1] Indicates whether this identifier ie endorsed by the official owner of the associated naming system authoritative : boolean [0..1] Indicates how the system may be identified when referenced in electronic exchange uniqueId [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>

 <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:

  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:
  fhir:

  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:

    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
  • No Changes 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 .

Conversions between R3 and R4 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

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . NamingSystem TU DomainResource System of unique identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Root systems cannot have uuid identifiers
+ Rule: Can't have more than one preferred identifier for a type
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the naming system (business identifier)

. . . version Σ 0..1 string Business version of the naming system
... name Σ C 1..1 string Name for this naming system (computer friendly)
... title Σ T 1..1 0..1 string Name Title for this naming system (computer (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . kind Σ 1..1 code codesystem | identifier | root
NamingSystemType ( Required )
. . . date experimental Σ 1..1 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

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

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

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

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

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

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

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

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

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

. . . . type Σ 1..1 code oid | uuid | uri | v2csmnemonic | other
NamingSystemIdentifierType ( Required )
. . . . value Σ 1..1 string The unique identifier
. . . . preferred C 0..1 boolean Is this the id that should be used for this type
+ Rule: Can't have more than one preferred identifier for a type
. . . . comment 0..1 string Notes about identifier usage
. . . . period 0..1 Period When is identifier valid?
. . . . authoritative C 0..1 boolean Whether 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

NamingSystem ( DomainResource ) + MetadataResource An 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 servers url : 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 instance identifier : 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 sequence version : 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 generation name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the naming system title : 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 usage experimental : boolean [0..1] The date (and optionally time) when the naming system was published. 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 changes date : dateTime [1..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the naming system publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision responsible : string [0..1] Categorizes a naming system for easier search by grouping related naming systems type : CodeableConcept [0..1] « null (Strength=Extensible) (Strength=Preferred) Identifier Type 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, etc description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the naming system is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this naming system is needed and why it has been designed as it has purpose : 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 system copyright : 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 usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the NamingSystem content was or is planned to be in active use effectivePeriod : 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 searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the NamingSystem author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the NamingSystem editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the NamingSystem reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the NamingSystem for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*] Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc usage : string [0..1] UniqueId Identifies the unique identifier scheme used for this particular identifier type : code [1..1] « null (Strength=Required) NamingSystemIdentifierType ! » The string that should be sent over the wire to identify the code system or identifier system value : string [1..1] Indicates whether this identifier is the "preferred" identifier of this type preferred : boolean [0..1] Notes about the past or intended usage of this identifier comment : 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-deterministic period : Period [0..1] Indicates whether this identifier ie endorsed by the official owner of the associated naming system authoritative : boolean [0..1] Indicates how the system may be identified when referenced in electronic exchange uniqueId [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>

 <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:

  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:
  fhir:

  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:

    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
  • No Changes 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 .

Conversions between R3 and R4 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). )

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

4.11.5.1 Terminology Bindings

Path Definition Type Reference
NamingSystem.status

The lifecycle status of an artifact.

Required PublicationStatus
NamingSystem.kind

Identifies the purpose of the naming system.

Required NamingSystemType
NamingSystem.type

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

Extensible Preferred Identifier Type Codes NamingSystemIdentifierSystemType (a valid code from identifierType icon )
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 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

 Extensible Jurisdiction ValueSet JurisdictionValueSet
NamingSystem.topic

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

Example DefinitionTopic
NamingSystem.uniqueId.type

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

Required NamingSystemIdentifierType

4.11.5.2 Constraints

id UniqueKey Level Location Description Expression
nsd-0 img  cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
nsd-1 img  nsd-1 Rule (base) Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 img  cnl-1 Warning NamingSystem.url URL should not contain | or # - these characters make processing canonical references problematic url.matches('([^|#])*')
img  nsd-2 Rule (base) NamingSystem.uniqueId.preferred Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
img  nsd-3 Rule NamingSystem.uniqueId.authoritative 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).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.

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