NamingSystem

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.

Schema

Properties

Name	Required	Type	Description
name	✓	string	Name for this naming system (computer friendly) Details 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. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.
status	✓	code	draft | active | retired | unknown Details The status of this naming system. Enables tracking the life-cycle of the content. Allows filtering of naming systems that are appropriate for use versus not.
kind	✓	code	codesystem | identifier | root Details Indicates the purpose for the naming system - what kinds of things does it make unique?
date	✓	dateTime	Date last changed Details The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisher		string	Name of the publisher (organization or individual) Details The name of the organization or individual that published the naming system. Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.
contact		ContactDetail[]	Contact details for the publisher Details Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
responsible		string	Who maintains system namespace? Details The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization. Responsibility for some aspects of a namespace may be delegated.
type		CodeableConcept	e.g. driver, provider, patient, bank etc. Details Categorizes a naming system for easier search by grouping related naming systems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.
description		markdown	Natural language description of the naming system Details 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. This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).
useContext		UsageContext[]	The context that the content is intended to support Details The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdiction		CodeableConcept[]	Intended jurisdiction for naming system (if applicable) Details A legal or geographic region in which the naming system is intended to be used. It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
usage		string	How/where is it used Details Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
uniqueId	✓	NamingSystemUniqueId[]	Unique identifiers used for system Details Indicates how the system may be identified when referenced in electronic exchange. Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
type	✓	code	oid | uuid | uri | other Details Identifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.
value	✓	string	The unique identifier Details The string that should be sent over the wire to identify the code system or identifier system. If the value is a URI intended for use as FHIR system identifier, the URI should not contain "\" or "?" or "," since this makes escaping very difficult.
preferred		boolean	Is this the id that should be used for this type Details Indicates whether this identifier is the "preferred" identifier of this type.
comment		string	Notes about identifier usage Details Notes about the past or intended usage of this identifier. e.g. "must be used in Germany" or "was initially published in error with this value".
period		Period	When is identifier valid? Details 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. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).

Search Parameters

Name	Type	Description	Expression
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
date	date	The naming system publication date	NamingSystem.date
description	string	The description of the naming system	NamingSystem.description
jurisdiction	token	Intended jurisdiction for the naming system	NamingSystem.jurisdiction
name	string	Computationally friendly name of the naming system	NamingSystem.name
publisher	string	Name of the publisher of the naming system	NamingSystem.publisher
status	token	The current status of the naming system	NamingSystem.status
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the naming system	NamingSystem.useContext
context-type-value	composite	A use context type and value assigned to the naming system	NamingSystem.useContext
contact	string	Name of an individual to contact	NamingSystem.contact.name
id-type	token	oid | uuid | uri | other	NamingSystem.uniqueId.type
kind	token	codesystem | identifier | root	NamingSystem.kind
period	date	When is identifier valid?	NamingSystem.uniqueId.period
responsible	string	Who maintains system namespace?	NamingSystem.responsible
telecom	token	Contact details for individual or organization	NamingSystem.contact.telecom
type	token	e.g. driver, provider, patient, bank etc.	NamingSystem.type
value	string	The unique identifier	NamingSystem.uniqueId.value

Inherited Properties

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta		Meta	Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
language		code	Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.

Relationships

The CodeSystem resource defines the content of a code system, and also its preferred identifier. The NamingSystem resource identifies the existence of a code or identifier system, and its possible and preferred identifiers. The key difference between the resources is who creates and manages them - CodeSystem resources are managed by the owner of the code system resource, who can properly define the features and content of the code system. 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 do not have the authority to define the features and content. Additionally, there may be multiple authoritative NamingSystem resources for a code system, but there should only be one CodeSystem resource.

Background and Context

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