This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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
Vocabulary 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.
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.
A NamingSystem
resource manages identifiers of a code system or identifier system, identifier metadata (e.g. type), and limited code system or identifier system specific metadata (e.g. publisher and description).
A CodeSystem
resource represents a code system, its key properties, and may include the content, identifiers, and other metadata.
There is known overlap between the CodeSystem
and NamingSystem
resource elements. However, the key differences between the resources are as follows:
CodeSystem
resources may include the concept and property content of the code system, whereas NamingSystem
resources do not. CodeSystem
resources also allow identifiers to be supplemented by specific metadata. The metadata are supported with extensions.NamingSystem
resources allow the identifiers for code systems or identifier systems to be supplemented by metadata specific to the identifiers. For example: preferred, authoritative, and validity period.For discussion of policy for creating well maintained OIDs and URIs for resources, see The HL7 Confluence site .
No references for this Resource.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 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 | Σ | 0..1 | string | Title for this naming system (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
kind | Σ | 1..1 | code | codesystem | identifier | root NamingSystemType (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 1..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
responsible | 0..1 | string | Who maintains system namespace? | |
type | 0..1 | CodeableConcept | e.g. driver, provider, patient, bank etc. NamingSystemIdentifierSystemType (Preferred) | |
description | 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 (Extensible) |
purpose | 0..1 | markdown | Why this naming system is defined | |
copyright | 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 | 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) |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<NamingSystem xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier> <version value="[string]"/><!-- 0..1 Business version of the naming system --> <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) --> <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? --> <type><!-- 0..1 CodeableConcept e.g. driver, provider, patient, bank etc. --></type> <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed --> <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <usage value="[string]"/><!-- 0..1 How/where is it used --> <uniqueId> <!-- 1..* Unique identifiers used for system --> <type value="[code]"/><!-- 1..1 oid | uuid | uri | v2csmnemonic | other --> <value value="[string]"/><!-- 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- 0..1 Notes about identifier usage --> <period><!-- 0..1 Period When is identifier valid? --></period> <authoritative value="[boolean]"/><!-- 0..1 Whether the identifier is authoritative --> </uniqueId> </NamingSystem>
JSON Template
{ "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/> . [ a fhir:NamingSystem; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) fhir:NamingSystem.identifier [ Identifier ], ... ; # 0..* Additional identifier for the naming system (business identifier) fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system fhir:NamingSystem.name [ string ]; # 1..1 I Name for this naming system (computer friendly) fhir:NamingSystem.title [ string ]; # 0..1 Title for this naming system (human friendly) fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root fhir:NamingSystem.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual) fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace? fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver, provider, patient, bank etc. fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable) fhir:NamingSystem.purpose [ markdown ]; # 0..1 Why this naming system is defined fhir:NamingSystem.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:NamingSystem.approvalDate [ date ]; # 0..1 When the NamingSystem was approved by publisher fhir:NamingSystem.lastReviewDate [ date ]; # 0..1 When the NamingSystem was last reviewed fhir:NamingSystem.effectivePeriod [ Period ]; # 0..1 When the NamingSystem is expected to be used fhir:NamingSystem.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc. fhir:NamingSystem.author [ ContactDetail ], ... ; # 0..* Who authored the CodeSystem fhir:NamingSystem.editor [ ContactDetail ], ... ; # 0..* Who edited the NamingSystem fhir:NamingSystem.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the NamingSystem fhir:NamingSystem.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the NamingSystem fhir:NamingSystem.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | v2csmnemonic | other fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid? fhir:NamingSystem.uniqueId.authoritative [ boolean ]; # 0..1 Whether the identifier is authoritative ], ...; ]
Changes since R4
NamingSystem | |
NamingSystem.url |
|
NamingSystem.identifier |
|
NamingSystem.version |
|
NamingSystem.title |
|
NamingSystem.experimental |
|
NamingSystem.type |
|
NamingSystem.purpose |
|
NamingSystem.copyright |
|
NamingSystem.approvalDate |
|
NamingSystem.lastReviewDate |
|
NamingSystem.effectivePeriod |
|
NamingSystem.topic |
|
NamingSystem.author |
|
NamingSystem.editor |
|
NamingSystem.reviewer |
|
NamingSystem.endorser |
|
NamingSystem.relatedArtifact |
|
NamingSystem.uniqueId.authoritative |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors).)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 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 | Σ | 0..1 | string | Title for this naming system (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
kind | Σ | 1..1 | code | codesystem | identifier | root NamingSystemType (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 1..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
responsible | 0..1 | string | Who maintains system namespace? | |
type | 0..1 | CodeableConcept | e.g. driver, provider, patient, bank etc. NamingSystemIdentifierSystemType (Preferred) | |
description | 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 (Extensible) |
purpose | 0..1 | markdown | Why this naming system is defined | |
copyright | 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 | 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) |
Documentation for this format |
See the Extensions for this resource
XML Template
<NamingSystem xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier> <version value="[string]"/><!-- 0..1 Business version of the naming system --> <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) --> <title value="[string]"/><!-- 0..1 Title for this naming system (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? --> <type><!-- 0..1 CodeableConcept e.g. driver, provider, patient, bank etc. --></type> <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this naming system is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the NamingSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the NamingSystem was last reviewed --> <effectivePeriod><!-- 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- 0..* ContactDetail Who edited the NamingSystem --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the NamingSystem --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the NamingSystem --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <usage value="[string]"/><!-- 0..1 How/where is it used --> <uniqueId> <!-- 1..* Unique identifiers used for system --> <type value="[code]"/><!-- 1..1 oid | uuid | uri | v2csmnemonic | other --> <value value="[string]"/><!-- 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- 0..1 Notes about identifier usage --> <period><!-- 0..1 Period When is identifier valid? --></period> <authoritative value="[boolean]"/><!-- 0..1 Whether the identifier is authoritative --> </uniqueId> </NamingSystem>
JSON Template
{ "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/> . [ a fhir:NamingSystem; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) fhir:NamingSystem.identifier [ Identifier ], ... ; # 0..* Additional identifier for the naming system (business identifier) fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system fhir:NamingSystem.name [ string ]; # 1..1 I Name for this naming system (computer friendly) fhir:NamingSystem.title [ string ]; # 0..1 Title for this naming system (human friendly) fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root fhir:NamingSystem.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual) fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace? fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver, provider, patient, bank etc. fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable) fhir:NamingSystem.purpose [ markdown ]; # 0..1 Why this naming system is defined fhir:NamingSystem.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:NamingSystem.approvalDate [ date ]; # 0..1 When the NamingSystem was approved by publisher fhir:NamingSystem.lastReviewDate [ date ]; # 0..1 When the NamingSystem was last reviewed fhir:NamingSystem.effectivePeriod [ Period ]; # 0..1 When the NamingSystem is expected to be used fhir:NamingSystem.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc. fhir:NamingSystem.author [ ContactDetail ], ... ; # 0..* Who authored the CodeSystem fhir:NamingSystem.editor [ ContactDetail ], ... ; # 0..* Who edited the NamingSystem fhir:NamingSystem.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the NamingSystem fhir:NamingSystem.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the NamingSystem fhir:NamingSystem.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | v2csmnemonic | other fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid? fhir:NamingSystem.uniqueId.authoritative [ boolean ]; # 0..1 Whether the identifier is authoritative ], ...; ]
Changes since Release 4
NamingSystem | |
NamingSystem.url |
|
NamingSystem.identifier |
|
NamingSystem.version |
|
NamingSystem.title |
|
NamingSystem.experimental |
|
NamingSystem.type |
|
NamingSystem.purpose |
|
NamingSystem.copyright |
|
NamingSystem.approvalDate |
|
NamingSystem.lastReviewDate |
|
NamingSystem.effectivePeriod |
|
NamingSystem.topic |
|
NamingSystem.author |
|
NamingSystem.editor |
|
NamingSystem.reviewer |
|
NamingSystem.endorser |
|
NamingSystem.relatedArtifact |
|
NamingSystem.uniqueId.authoritative |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors).)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
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. | Preferred | NamingSystemIdentifierSystemType |
NamingSystem.jurisdiction | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) . | Extensible | Jurisdiction ValueSet |
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 |
UniqueKey | Level | Location | Description | Expression |
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}') |
nsd-1 | Rule | (base) | Root systems cannot have uuid identifiers | kind != 'root' or uniqueId.all(type != 'uuid') |
cnl-1 | Warning | NamingSystem.url | URL should not contain | or # - these characters make processing canonical references problematic | url.matches('([^|#])*') |
nsd-2 | Rule | NamingSystem.uniqueId.preferred | Can't have more than one preferred identifier for a type | uniqueId.where(preferred = true).select(type).isDistinct() |
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() |
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).
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
.
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 N | 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) | |
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) | |
context-type | token | A type of use context assigned to the naming system | NamingSystem.useContext.code | |
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) | |
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) | |
date N | date | The naming system publication date | NamingSystem.date | |
derived-from | reference | A resource that the NamingSystem is derived from | NamingSystem.relatedArtifact.where(type='derived-from').resource (Any) | |
description N | string | The description of the naming system | NamingSystem.description | |
effective | date | The time during which the NamingSystem is intended to be in use | NamingSystem.effectivePeriod | |
id-type N | token | oid | uuid | uri | other | NamingSystem.uniqueId.type | |
identifier | token | External identifier for the naming system | NamingSystem.identifier | |
jurisdiction | token | Intended jurisdiction for the naming system | NamingSystem.jurisdiction | |
kind N | token | codesystem | identifier | root | NamingSystem.kind | |
name N | string | Computationally friendly name of the naming system | NamingSystem.name | |
period | date | When is identifier valid? | NamingSystem.uniqueId.period | |
predecessor | reference | The predecessor of the NamingSystem | NamingSystem.relatedArtifact.where(type='predecessor').resource (Any) | |
publisher N | string | Name of the publisher of the naming system | NamingSystem.publisher | |
responsible N | string | Who maintains system namespace? | NamingSystem.responsible | |
status N | token | The current status of the naming system | NamingSystem.status | |
telecom | token | Contact details for individual or organization | NamingSystem.contact.telecom | |
topic | token | Topics associated with the NamingSystem | NamingSystem.topic | |
type | token | e.g. driver, provider, patient, bank etc. | NamingSystem.type | |
url N | uri | The uri that identifies the naming system | NamingSystem.url | |
value N | string | The unique identifier | NamingSystem.uniqueId.value | |
version N | token | The business version of the naming system | NamingSystem.version |