R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Terminology Infrastructure icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Anonymous Compartments: No 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.

Short DisplaySystem of unique identification
Cardinality0..*
TypeMetadataResource
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.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
nsd-1Rule Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
nsd-2Rule Can't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
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.toString() & period.start.toString() & period.end.toString()).isDistinct()
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 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.

Short DisplayCanonical identifier for this naming system, represented as a URI (globally unique)
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.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
NamingSystem.identifier
Element IdNamingSystem.identifier
Definition

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.

Short DisplayAdditional identifier for the naming system (business identifier)
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the naming system.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.

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.

Short DisplayBusiness version of the naming system
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]. The version SHOULD NOT contain a '#' - see Business Version.

NamingSystem.versionAlgorithm[x]
Element IdNamingSystem.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

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.

Short DisplayName for this naming system (computer friendly)
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.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
NamingSystem.title
Element IdNamingSystem.title
Definition

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

Short DisplayTitle for this naming system (human friendly)
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.

Short Displaydraft | active | retired | unknown
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.

See guidance around (not) making local changes to elements here.

NamingSystem.kind
Element IdNamingSystem.kind
Definition

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

Short Displaycodesystem | identifier | root
Cardinality1..1
Terminology BindingNaming System Type (Required)
Typecode
Summarytrue
Invariants
Affect this element
nsd-1Rule Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
NamingSystem.experimental
Element IdNamingSystem.experimental
Definition

A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level naming system.

Summarytrue
Comments

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

NamingSystem.date
Element IdNamingSystem.date
Definition

The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

Short DisplayDate last changed
Cardinality1..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here.

NamingSystem.publisher
Element IdNamingSystem.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the naming system.

Short DisplayName of the publisher/steward (organization or individual)
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.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

See guidance around (not) making local changes to elements here.

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.

Short DisplayWho maintains system namespace?
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.

Short Displaye.g. driver, provider, patient, bank etc
Cardinality0..1
Terminology BindingNaming System Identifier System Type (Preferred)
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.

Short DisplayNatural language description of the naming system
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as 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.

Short DisplayThe context that the content is intended to support
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
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdNamingSystem.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for naming system (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (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.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

NamingSystem.purpose
Element IdNamingSystem.purpose
Definition

Explanation of why this naming system is needed and why it has been designed as it has.

Short DisplayWhy this naming system is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.

NamingSystem.copyright
Element IdNamingSystem.copyright
Definition

A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the naming system and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
NamingSystem.copyrightLabel
Element IdNamingSystem.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

NamingSystem.approvalDate
Element IdNamingSystem.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the NamingSystem was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

NamingSystem.lastReviewDate
Element IdNamingSystem.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the NamingSystem was last reviewed by the publisher
Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Summaryfalse
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

NamingSystem.effectivePeriod
Element IdNamingSystem.effectivePeriod
Definition

The period during which the NamingSystem content was or is planned to be in active use.

Short DisplayWhen the NamingSystem is expected to be used
Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the NamingSystem are or are expected to be used instead.

Summarytrue
Comments

The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

NamingSystem.topic
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdNamingSystem.topic
Definition

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.

Short DisplayE.g. Education, Treatment, Assessment, etc
Cardinality0..*
Terminology BindingDefinition Topic (Example)
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the NamingSystem so that it can be found by topical and keyword searches.

Summaryfalse
Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

NamingSystem.author
Element IdNamingSystem.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the NamingSystem.

Short DisplayWho authored the CodeSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
NamingSystem.editor
Element IdNamingSystem.editor
Definition

An individual or organization primarily responsible for internal coherence of the NamingSystem.

Short DisplayWho edited the NamingSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
NamingSystem.reviewer
Element IdNamingSystem.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem.

Short DisplayWho reviewed the NamingSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

NamingSystem.endorser
Element IdNamingSystem.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting.

Short DisplayWho endorsed the NamingSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

See guidance around (not) making local changes to elements here.

NamingSystem.relatedArtifact
Element IdNamingSystem.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Short DisplayAdditional documentation, citations, etc
Cardinality0..*
TypeRelatedArtifact
Requirements

A NamingSystem must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Summaryfalse
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

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.

Short DisplayHow/where is it used
Cardinality0..1
Typestring
Summaryfalse
NamingSystem.uniqueId
Element IdNamingSystem.uniqueId
Definition

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

Short DisplayUnique identifiers used for system
Cardinality1..*
Summarytrue
Comments

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

Invariants
Affect this element
nsd-1Rule Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
nsd-2Rule Can't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
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.toString() & period.start.toString() & period.end.toString()).isDistinct()
NamingSystem.uniqueId.type
Element IdNamingSystem.uniqueId.type
Definition

Identifies the unique identifier scheme used for this particular identifier.

Short Displayoid | uuid | uri | iri-stem | v2csmnemonic | other
Cardinality1..1
Terminology BindingNaming System Identifier Type (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. Preferred identifiers for the same identifier type SHOULD NOT overlap by period.

Invariants
Affect this element
nsd-1Rule Root systems cannot have uuid identifierskind != 'root' or uniqueId.all(type != 'uuid')
nsd-2Rule Can't have more than one preferred identifier for a typeuniqueId.where(preferred = true).select(type).isDistinct()
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.toString() & period.start.toString() & period.end.toString()).isDistinct()
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.

Short DisplayThe unique identifier
Cardinality1..1
Typestring
Summarytrue
Comments

If the value is a URI intended for use as FHIR system identifier, the URI should not contain "&quot; 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.

Short DisplayIs this the id that should be used for 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
Affect 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.

Short DisplayNotes about identifier usage
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.

Short DisplayWhen is identifier valid?
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).

The nuance of identifier deprecation is not represented with a separate element. When a determination is made that an identifier should not be used, the validity period end date is updated with the date the identifier is deemed to be deprecated. The identifier should no longer be used once the period end date is reached.

Invariants
Affect 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.toString() & period.start.toString() & period.end.toString()).isDistinct()
NamingSystem.uniqueId.authoritative
Element IdNamingSystem.uniqueId.authoritative
Definition

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

Short DisplayWhether the identifier is authoritative
Cardinality0..1
Typeboolean
Summaryfalse
Invariants
Affect 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.toString() & period.start.toString() & period.end.toString()).isDistinct()