FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

4.10 4.11 Resource NamingSystem - Content

FHIR Responsible Owner: Terminology Infrastructure icon Work Group   Normative Maturity Level : 1   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" "System" used within the Identifier and Coding data types.

4.10.1 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.10.2 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.10.3 4.11.3 Background and Context

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

4.11.4 References to this Resource

No references for this Resource.

4.10.4 4.11.5 Resource Content

Structure

Context Intended jurisdiction for
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . NamingSystem I N 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
+ Can only Rule: Can't have replacedBy if naming system is retired more than one preferred identifier for a type
+ Rule: Can't have more than one preferred authoritative identifier for a type type/period combination (only one authoritative identifier allowed at any given point of time)

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . name . 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
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString 1..1 string
. . . . versionAlgorithmCoding Coding
... name Σ C 1..1 string Name for this naming system (computer friendly)
. . . status title Σ T 0..1 string Title for this naming system (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . kind Σ C 1..1 code codesystem | identifier | root
NamingSystemType Binding: Naming System Type ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . date Σ 1..1 dateTime Date this was 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. etc
Binding: Naming System Identifier System Type Codes ( 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 Jurisdiction of the authority that maintains the naming system (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . usage purpose T 0..1 markdown Why this naming system is defined
... copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the NamingSystem is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( 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 C 0..* RelatedArtifact Additional documentation, citations, etc
+ Rule: Related artifact can't be depends-on or composed-of

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

. . . . type Σ C 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
NamingSystemIdentifierType Binding: Naming System Identifier Type ( Required )
. . . . value Σ 1..1 string The unique identifier
. . . . preferred C 0..1 boolean Is this the id that should be used for this type
. . . . comment 0..1 string Notes about identifier usage
. . . . period C 0..1 Period When is identifier valid?
. . . replacedBy . authoritative I C 0..1 Reference ( NamingSystem boolean ) Whether the identifier is authoritative
Use this instead

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] Indicates the mechanism used to compare versions to determine which NamingSystem is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code 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] « The lifecycle status of a Value Set or Concept Map. null (Strength=Required) PublicationStatus ! » Indicates the purpose for the naming system - what kinds of things does it make unique? kind : code [1..1] « Identifies the purpose of the naming system. null (Strength=Required) NamingSystemType ! » « This element has or is affected by some invariants C » A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended 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 if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes date : dateTime [1..1] The name of the individual or organization that published or individual 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] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible) null (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 terms 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 authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this naming system is intended 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 notices of intellectual property ownership and can include restrictions on the use and publishing of the naming system copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for 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 used in active use jurisdiction 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 ?? » Countries An individiual or organization primarily involved in the creation and regions within which this artifact is targeted 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 asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use (Strength=Extensible) in some setting Jurisdiction ValueSet endorser + : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. If the type is `successor` or `predecessor`, the related resource must be a NamingSystem 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] For naming systems that are retired, indicates the naming system that should be used in their place (if any) replacedBy : Reference [0..1] NamingSystem UniqueId Identifies the unique identifier scheme used for this particular identifier type : code [1..1] « Identifies the style of unique identifier used to identify a namespace. null (Strength=Required) NamingSystemIdentifierType ! » « This element has or is affected by some invariants C » 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" "preferred" identifier of this type preferred : boolean [0..1] « This element has or is affected by some invariants C » 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] « This element has or is affected by some invariants C » Indicates whether this identifier ie endorsed by the official owner of the associated naming system authoritative : boolean [0..1] « This element has or is affected by some invariants C » 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 -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for 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>
 <
 <</type>
 <
 <</useContext>
 <</jurisdiction>
 <
 <
  <
  <
  <
  <
  <</period>

 <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 Jurisdiction of the authority that maintains the naming system (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author>
 <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- I 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- I 0..1 Period When is identifier valid? --></period>
  <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative -->

 </uniqueId>
 <</replacedBy>

</NamingSystem>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "NamingSystem",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "
    "
  }],
  "

  "url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the naming system (business identifier)
  "version" : "<string>", // Business version of the naming system
  // versionAlgorithm[x]: How to compare versions. One of these 2:

  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this naming system (computer friendly)
  "title" : "<string>", // Title for this naming system (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  codesystem | identifier | root
  "experimental" : <boolean>, // For testing only - never for 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 }], // Jurisdiction of the authority that maintains the naming system (if applicable) icon
  "purpose" : "<markdown>", // Why this naming system is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the NamingSystem is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the CodeSystem
  "editor" : [{ ContactDetail }], // Who edited the NamingSystem
  "reviewer" : [{ ContactDetail }], // Who reviewed the NamingSystem
  "endorser" : [{ ContactDetail }], // Who endorsed the NamingSystem
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "usage" : "<string>", // How/where is it used
  "uniqueId" : [{ // I R!  Unique identifiers used for system
    "type" : "<code>", // I R!  oid | uuid | uri | iri-stem | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // I Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // I When is identifier valid?
    "authoritative" : <boolean> // I Whether the identifier is authoritative
  }]

}

Turtle Template 

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


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

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:

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

]

Changes since DSTU2 from both R4 and R4B

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.versionAlgorithm[x]
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.status NamingSystem.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/identifier-type` (extensible)
NamingSystem.jurisdiction
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status http://hl7.org/fhir/ValueSet/jurisdiction to http://hl7.org/fhir/ValueSet/publication-status Jurisdiction ValueSet icon
NamingSystem.contact NamingSystem.purpose
  • Type changed from BackboneElement to ContactDetail Added Element
NamingSystem.description NamingSystem.copyright
  • Type changed from string to markdown Added Element
NamingSystem.useContext NamingSystem.copyrightLabel
  • Type changed from CodeableConcept to UsageContext Added Element
NamingSystem.approvalDate
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible) Added Element
NamingSystem.jurisdiction NamingSystem.lastReviewDate
  • Added Element
NamingSystem.uniqueId.comment NamingSystem.effectivePeriod
  • Added Element
NamingSystem.contact.name NamingSystem.topic
  • deleted Added Element
NamingSystem.contact.telecom NamingSystem.author
  • deleted Added Element
NamingSystem.editor
  • Added Element
NamingSystem.reviewer
  • Added Element
NamingSystem.endorser
  • Added Element
NamingSystem.relatedArtifact
  • Added Element
NamingSystem.uniqueId.type
  • Add codes iri-stem , v2csmnemonic
NamingSystem.uniqueId.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R2 <--> R3 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). for R4B as XML or JSON .

Structure

Context Intended jurisdiction for
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . NamingSystem I N 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
+ Can only Rule: Can't have replacedBy if naming system is retired more than one preferred identifier for a type
+ Rule: Can't have more than one preferred authoritative identifier for a type type/period combination (only one authoritative identifier allowed at any given point of time)

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . name . 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
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString 1..1 string
. . . . versionAlgorithmCoding Coding
... name Σ C 1..1 string Name for this naming system (computer friendly)
. . . status title Σ T 0..1 string Title for this naming system (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . kind Σ C 1..1 code codesystem | identifier | root
NamingSystemType Binding: Naming System Type ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . date Σ 1..1 dateTime Date this was 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. etc
Binding: Naming System Identifier System Type Codes ( 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 Jurisdiction of the authority that maintains the naming system (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . usage purpose T 0..1 markdown Why this naming system is defined
... copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the NamingSystem is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( 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 C 0..* RelatedArtifact Additional documentation, citations, etc
+ Rule: Related artifact can't be depends-on or composed-of

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

. . . . type Σ C 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
NamingSystemIdentifierType Binding: Naming System Identifier Type ( Required )
. . . . value Σ 1..1 string The unique identifier
. . . . preferred C 0..1 boolean Is this the id that should be used for this type
. . . . comment 0..1 string Notes about identifier usage
. . . . period C 0..1 Period When is identifier valid?
. . . replacedBy . authoritative I C 0..1 Reference ( NamingSystem boolean ) Whether the identifier is authoritative
Use this instead

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] Indicates the mechanism used to compare versions to determine which NamingSystem is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code 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] « The lifecycle status of a Value Set or Concept Map. null (Strength=Required) PublicationStatus ! » Indicates the purpose for the naming system - what kinds of things does it make unique? kind : code [1..1] « Identifies the purpose of the naming system. null (Strength=Required) NamingSystemType ! » « This element has or is affected by some invariants C » A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended 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 if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes date : dateTime [1..1] The name of the individual or organization that published or individual 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] « A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (Strength=Extensible) null (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 terms 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 authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this naming system is intended 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 notices of intellectual property ownership and can include restrictions on the use and publishing of the naming system copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for 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 used in active use jurisdiction 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 ?? » Countries An individiual or organization primarily involved in the creation and regions within which this artifact is targeted 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 asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use (Strength=Extensible) in some setting Jurisdiction ValueSet endorser + : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. If the type is `successor` or `predecessor`, the related resource must be a NamingSystem 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] For naming systems that are retired, indicates the naming system that should be used in their place (if any) replacedBy : Reference [0..1] NamingSystem UniqueId Identifies the unique identifier scheme used for this particular identifier type : code [1..1] « Identifies the style of unique identifier used to identify a namespace. null (Strength=Required) NamingSystemIdentifierType ! » « This element has or is affected by some invariants C » 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" "preferred" identifier of this type preferred : boolean [0..1] « This element has or is affected by some invariants C » 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] « This element has or is affected by some invariants C » Indicates whether this identifier ie endorsed by the official owner of the associated naming system authoritative : boolean [0..1] « This element has or is affected by some invariants C » 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 -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for 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>
 <
 <</type>
 <
 <</useContext>
 <</jurisdiction>
 <
 <
  <
  <
  <
  <
  <</period>

 <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 Jurisdiction of the authority that maintains the naming system (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author>
 <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <usage value="[string]"/><!-- 0..1 How/where is it used -->
 <uniqueId>  <!-- I 1..* Unique identifiers used for system -->
  <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other -->
  <value value="[string]"/><!-- 1..1 The unique identifier -->
  <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type -->
  <comment value="[string]"/><!-- 0..1 Notes about identifier usage -->
  <period><!-- I 0..1 Period When is identifier valid? --></period>
  <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative -->

 </uniqueId>
 <</replacedBy>

</NamingSystem>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "NamingSystem",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "
    "
  }],
  "

  "url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the naming system (business identifier)
  "version" : "<string>", // Business version of the naming system
  // versionAlgorithm[x]: How to compare versions. One of these 2:

  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this naming system (computer friendly)
  "title" : "<string>", // Title for this naming system (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  codesystem | identifier | root
  "experimental" : <boolean>, // For testing only - never for 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 }], // Jurisdiction of the authority that maintains the naming system (if applicable) icon
  "purpose" : "<markdown>", // Why this naming system is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the NamingSystem was approved by publisher
  "lastReviewDate" : "<date>", // When the NamingSystem was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the NamingSystem is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the CodeSystem
  "editor" : [{ ContactDetail }], // Who edited the NamingSystem
  "reviewer" : [{ ContactDetail }], // Who reviewed the NamingSystem
  "endorser" : [{ ContactDetail }], // Who endorsed the NamingSystem
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "usage" : "<string>", // How/where is it used
  "uniqueId" : [{ // I R!  Unique identifiers used for system
    "type" : "<code>", // I R!  oid | uuid | uri | iri-stem | v2csmnemonic | other
    "value" : "<string>", // R!  The unique identifier
    "preferred" : <boolean>, // I Is this the id that should be used for this type
    "comment" : "<string>", // Notes about identifier usage
    "period" : { Period }, // I When is identifier valid?
    "authoritative" : <boolean> // I Whether the identifier is authoritative
  }]

}

Turtle Template 

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


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

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:

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

]

Changes since DSTU2 from both R4 and R4B

NamingSystem
NamingSystem.url
  • Added Element
NamingSystem.identifier
  • Added Element
NamingSystem.version
  • Added Element
NamingSystem.versionAlgorithm[x]
  • Added Element
NamingSystem.title
  • Added Element
NamingSystem.experimental
  • Added Element
NamingSystem.status NamingSystem.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/identifier-type` (extensible)
NamingSystem.jurisdiction
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status http://hl7.org/fhir/ValueSet/jurisdiction to http://hl7.org/fhir/ValueSet/publication-status Jurisdiction ValueSet icon
NamingSystem.purpose
  • Added Element
NamingSystem.contact NamingSystem.copyright
  • Type changed from BackboneElement to ContactDetail Added Element
NamingSystem.description NamingSystem.copyrightLabel
  • Type changed from string to markdown Added Element
NamingSystem.useContext NamingSystem.approvalDate
  • Type changed from CodeableConcept to UsageContext Added Element
NamingSystem.lastReviewDate
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible) Added Element
NamingSystem.jurisdiction NamingSystem.effectivePeriod
  • Added Element
NamingSystem.uniqueId.comment NamingSystem.topic
  • Added Element
NamingSystem.contact.name NamingSystem.author
  • deleted Added Element
NamingSystem.contact.telecom NamingSystem.editor
  • deleted Added Element
NamingSystem.reviewer
  • Added Element
NamingSystem.endorser
  • Added Element
NamingSystem.relatedArtifact
  • Added Element
NamingSystem.uniqueId.type
  • Add codes iri-stem , v2csmnemonic
NamingSystem.uniqueId.authoritative
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R2 <--> R3 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.). for R4B as XML or JSON .

 

Alternate Additional definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) , the spreadsheet version & the dependency analysis

4.10.4.1 4.11.5.1 Terminology Bindings

NamingSystem.status NamingSystem.jurisdiction
Path Definition ValueSet Type Reference Documentation
NamingSystem.versionAlgorithm[x] The lifecycle status of a Value Set or Concept Map. VersionAlgorithm Required Extensible

Indicates the mechanism used to compare versions to determine which is more current.

NamingSystem.status PublicationStatus Required

The lifecycle status of an artifact.

NamingSystem.kind NamingSystemType Required

Identifies the purpose of the naming system.

NamingSystem.type Required NamingSystemIdentifierSystemType (a valid code from identifierType icon ) NamingSystemType Preferred NamingSystem.type A coded type for an

Identifies the style of unique identifier that can be used to determine which identifier to use for identify a specific purpose. namespace.

NamingSystem.jurisdiction JurisdictionValueSet icon Extensible Identifier Type Codes

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
NamingSystem.topic Countries and regions within which this artifact is targeted for use DefinitionTopic Extensible Example Jurisdiction ValueSet

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

NamingSystem.uniqueId.type NamingSystemIdentifierType Required

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

4.10.4.2 4.11.5.2 Constraints

4.10.4.3
UniqueKey Level Location Description Expression
nsd-1 : 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_]){1,254}$')
img  nsd-1 Rule (base) Root systems cannot have uuid identifiers ( expression : kind != 'root' or uniqueId.type = 'uuid' uniqueId.all(type != 'uuid') )
nsd-2 : img  cnl-1 Warning NamingSystem.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
img  nsd-2 Rule (base) Can't have more than one preferred identifier for a type ( expression : uniqueId.where(preferred = true).select(type).isDistinct() )
nsd-3 : Can only img  nsd-3 Rule (base) Can't have replacedBy if naming system is retired ( expression more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time) : replacedBy.empty() or status uniqueId.where(authoritative = 'retired' true).select(type.toString() & period.start.toString() & period.end.toString()).isDistinct() )
img  nsd-4 Rule NamingSystem.relatedArtifact Related artifact can't be depends-on or composed-of (type in ('depends-on' | 'composed-of')).not()

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 they didn't recognize that their addition replicates another. If this occurs, one of the system entries publisher should be deleted and contacted for guidance.

4.11.5.4 NamingSystem.url

The NamingSystem resource has a url property. The NamingSystem resource also specifies preferred identifiers for the Identifier or Code system that is being described. These are not the same thing; the remaining entry should have its uniqueId url updated to include any property of the NamingSystem itself identifies the registration of the system - the description itself, where as the preferred identifiers present on identify the original entry (and possibly have its descriptive information modified to include additional information from system being described.

The NamingSystem.url SHOULD not be the duplicate entry). same as a URL in the preferred identifiers list, and it would not therefore appear in a Coding.system or an Identifier.system .

4.10.5 4.11.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

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.ofType(CodeableConcept)) 25 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the naming system (NamingSystem.useContext.value.ofType(Quantity)) | (NamingSystem.useContext.value.ofType(Range)) 25 Resources
context-type token A type of use context assigned to the naming system NamingSystem.useContext.code 25 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.ofType(Quantity) | value.ofType(Range) 		25 Resources
context-type-value composite A use context type and value assigned to the naming system On NamingSystem.useContext:
  context-type: code
  context: value.ofType(CodeableConcept) 		25 Resources
date date The naming system publication date NamingSystem.date 26 Resources
derived-from reference A resource that the NamingSystem is derived from NamingSystem.relatedArtifact.where(type='derived-from').resource
(Any) 		9 Resources
description string The description of the naming system NamingSystem.description 24 Resources
effective date id-type The time during which the NamingSystem is intended to be in use NamingSystem.effectivePeriod 10 Resources
experimental token Whether the NamingSystem is experimental NamingSystem.experimental
id-type token oid | uuid | uri | other NamingSystem.uniqueId.type
identifier token External identifier for the naming system NamingSystem.identifier 30 Resources
jurisdiction token Intended jurisdiction for Jurisdiction of the authority that maintains the the naming system NamingSystem.jurisdiction 22 Resources
kind token codesystem | identifier | root NamingSystem.kind
name string Computationally friendly name of the naming system NamingSystem.name 24 Resources
period date When is identifier valid? NamingSystem.uniqueId.period
publisher predecessor string reference Name of the publisher The predecessor of the naming system NamingSystem NamingSystem.publisher NamingSystem.relatedArtifact.where(type='predecessor').resource
(Any) 		9 Resources
replaced-by publisher reference string Use this instead Name of the publisher of the naming system NamingSystem.replacedBy ( NamingSystem ) NamingSystem.publisher 26 Resources
responsible string Who maintains system namespace? NamingSystem.responsible
status token The current status of the naming system NamingSystem.status 30 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 30 Resources
value string The unique identifier NamingSystem.uniqueId.value
version token The business version of the naming system NamingSystem.version 27 Resources