Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft 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

FHIR Infrastructure Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the NamingSystem resource.

NamingSystem
Element IdNamingSystem
Definition

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.

Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
nsd-1Rule Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
NamingSystem.url
Element IdNamingSystem.url
Definition

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

Cardinality0..1
Typeuri
Requirements

Allows the naming system to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

NamingSystem.version
Element IdNamingSystem.version
Definition

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.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different naming system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the naming system with the format [url]|[version].

NamingSystem.name
Element IdNamingSystem.name
Definition

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.

Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

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.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
NamingSystem.title
Element IdNamingSystem.title
Definition

A short, descriptive, user-friendly title for the naming system.

Cardinality0..1
Typestring
Summarytrue
Comments

This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

NamingSystem.status
Element IdNamingSystem.status
Definition

The status of this naming system. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of naming systems that are appropriate for use versus not.

NamingSystem.kind
Element IdNamingSystem.kind
Definition

Indicates the purpose for the naming system - what kinds of things does it make unique?

Cardinality1..1
Terminology BindingNamingSystemType (Required)
Typecode
Summarytrue
NamingSystem.date
Element IdNamingSystem.date
Definition

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.

Cardinality1..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

NamingSystem.publisher
Element IdNamingSystem.publisher
Definition

The name of the organization or individual that published the naming system.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the naming system. May also allow for contact.

Summarytrue
Comments

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.

NamingSystem.contact
Element IdNamingSystem.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

NamingSystem.responsible
Element IdNamingSystem.responsible
Definition

The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

Cardinality0..1
Typestring
Summaryfalse
Comments

This is the primary organization. Responsibility for some aspects of a namespace may be delegated.

NamingSystem.type
Element IdNamingSystem.type
Definition

Categorizes a naming system for easier search by grouping related naming systems.

Cardinality0..1
Terminology BindingIdentifierType (Extensible)
TypeCodeableConcept
Summaryfalse
Comments

This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.

NamingSystem.description
Element IdNamingSystem.description
Definition

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.

Cardinality0..1
Typemarkdown
Summaryfalse
Comments

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).

NamingSystem.useContext
Element IdNamingSystem.useContext
Definition

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.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

NamingSystem.jurisdiction
Element IdNamingSystem.jurisdiction
Definition

A legal or geographic region in which the naming system is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.

NamingSystem.usage
Element IdNamingSystem.usage
Definition

Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

Cardinality0..1
Typestring
Summaryfalse
NamingSystem.uniqueId
Element IdNamingSystem.uniqueId
Definition

Indicates how the system may be identified when referenced in electronic exchange.

Cardinality1..*
Summarytrue
Comments

Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

NamingSystem.uniqueId.type
Element IdNamingSystem.uniqueId.type
Definition

Identifies the unique identifier scheme used for this particular identifier.

Cardinality1..1
Terminology BindingNamingSystemIdentifierType (Required)
Typecode
Summarytrue
Comments

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.

NamingSystem.uniqueId.value
Element IdNamingSystem.uniqueId.value
Definition

The string that should be sent over the wire to identify the code system or identifier system.

Cardinality1..1
Typestring
Summarytrue
Comments

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.

NamingSystem.uniqueId.preferred
Element IdNamingSystem.uniqueId.preferred
Definition

Indicates whether this identifier is the "preferred" identifier of this type.

Cardinality0..1
Typeboolean
Meaning if MissingIf there are multiple ids, and one is labeled "preferred", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn
Summaryfalse
Invariants
Defined on this element
nsd-2Rule Can't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
NamingSystem.uniqueId.comment
Element IdNamingSystem.uniqueId.comment
Definition

Notes about the past or intended usage of this identifier.

Cardinality0..1
Typestring
Summaryfalse
Comments

e.g. "must be used in Germany" or "was initially published in error with this value".

NamingSystem.uniqueId.period
Element IdNamingSystem.uniqueId.period
Definition

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.

Cardinality0..1
TypePeriod
Summaryfalse
Comments

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).

NamingSystem.uniqueId.authoritative
Element IdNamingSystem.uniqueId.authoritative
Definition

Indicates whether this identifier ie endorsed by the official owner of the associated naming system.

Cardinality0..1
Typeboolean
Summaryfalse
Invariants
Defined on this element
nsd-3Rule 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()