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
.
Page
versions:
R5
R4B
R4
R3
R2
Work
Group
|
Normative
|
|
Compartments
:
|
Detailed Descriptions for the elements in the NamingSystem resource.
| NamingSystem | |||||||||||||||||||||
|
|
NamingSystem | ||||||||||||||||||||
| Definition |
A
curated
namespace
that
issues
unique
symbols
within
that
namespace
for
the
identification
of
concepts,
people,
devices,
etc.
Represents
a
|
||||||||||||||||||||
| Short Display | System of unique identification | ||||||||||||||||||||
|
|
0..* | ||||||||||||||||||||
|
| MetadataResource | ||||||||||||||||||||
|
| false | ||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.url | |||||||||||||||||||||
| Element Id | NamingSystem.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 Display | Canonical identifier for this naming system, represented as a URI (globally unique) | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | uri | ||||||||||||||||||||
| Requirements | Allows the naming system to be referenced by a single globally unique identifier. | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
Can
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. | ||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.identifier | |||||||||||||||||||||
| Element Id | NamingSystem.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 Display | Additional identifier for the naming system (business identifier) | ||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion ) | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | Identifier | ||||||||||||||||||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the naming system. | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| NamingSystem.version | |||||||||||||||||||||
| Element Id | NamingSystem.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 Display | Business version of the naming system | ||||||||||||||||||||
| Note |
This
is
| ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 Id | NamingSystem.versionAlgorithm[x] | ||||||||||||||||||||
| Definition | Indicates the mechanism used to compare versions to determine which NamingSystem is more current. | ||||||||||||||||||||
| Short Display | How to compare versions | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Terminology Binding |
Version
Algorithm
(
| ||||||||||||||||||||
| Type |
string
|
Coding
|
||||||||||||||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
|
| NamingSystem.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 Display | Name for this naming system (computer friendly) | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Requirements |
Support human navigation and code generation. |
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
The
name
is
not
expected
to
be
globally
unique.
The
name
should
be
a
simple
|
||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.title | |||||||||||||||||||||
| Element Id | NamingSystem.title | ||||||||||||||||||||
| Definition | A short, descriptive, user-friendly title for the naming system. | ||||||||||||||||||||
| Short Display | Title for this naming system (human friendly) | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments | This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||
| NamingSystem.status | |||||||||||||||||||||
|
| NamingSystem.status | ||||||||||||||||||||
| Definition |
The status of this naming system. Enables tracking the life-cycle of the content. |
||||||||||||||||||||
| Short Display | draft | active | retired | unknown | ||||||||||||||||||||
|
|
1..1 | ||||||||||||||||||||
| Terminology Binding | PublicationStatus ( Required ) | ||||||||||||||||||||
| Type | code | ||||||||||||||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
Allows
filtering
of
naming
systems
that
are
appropriate
for
use
See guidance around (not) making local changes to elements here . |
||||||||||||||||||||
| NamingSystem.kind | |||||||||||||||||||||
|
| NamingSystem.kind | ||||||||||||||||||||
| Definition |
Indicates the purpose for the naming system - what kinds of things does it make unique? |
||||||||||||||||||||
| Short Display | codesystem | identifier | root | ||||||||||||||||||||
|
|
1..1 | ||||||||||||||||||||
| Terminology Binding |
|
||||||||||||||||||||
| Type | code | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.experimental | |||||||||||||||||||||
| Element Id | NamingSystem.experimental | ||||||||||||||||||||
| Definition | 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. | ||||||||||||||||||||
| Short Display | For testing only - never for real usage | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||
| Meaning if Missing | If 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. | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments | Allows filtering of naming systems that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.). Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element. | ||||||||||||||||||||
| NamingSystem.date | |||||||||||||||||||||
|
| NamingSystem.date | ||||||||||||||||||||
| Definition |
The
date
(and
optionally
time)
when
the
naming
system
was
|
||||||||||||||||||||
| Short Display | Date last changed | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Type | dateTime | ||||||||||||||||||||
| Alternate Names | Revision Date | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
|
| NamingSystem.publisher | ||||||||||||||||||||
| Definition |
The
name
of
the
|
||||||||||||||||||||
| Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||
|
|
0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Requirements |
Helps
establish
the
|
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
Usually
an
|
||||||||||||||||||||
| NamingSystem.contact | |||||||||||||||||||||
|
| NamingSystem.contact | ||||||||||||||||||||
| Definition |
Contact details to assist a user in finding and communicating with the publisher. |
||||||||||||||||||||
| Short Display | Contact details for the publisher | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
|
| NamingSystem.responsible | ||||||||||||||||||||
| Definition |
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. |
||||||||||||||||||||
| Short Display | Who maintains system namespace? | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
|
|
false | ||||||||||||||||||||
| Comments |
This is the primary organization. Responsibility for some aspects of a namespace may be delegated. |
||||||||||||||||||||
| NamingSystem.type | |||||||||||||||||||||
|
|
NamingSystem.type | ||||||||||||||||||||
| Definition |
Categorizes a naming system for easier search by grouping related naming systems. |
||||||||||||||||||||
| Short Display | e.g. driver, provider, patient, bank etc | ||||||||||||||||||||
|
|
0..1 | ||||||||||||||||||||
| Terminology Binding |
Naming
System
Identifier
System
Type
|
||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
|
| false | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
|
| NamingSystem.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 Display | Natural language description of the naming system | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||
|
| false | ||||||||||||||||||||
| Comments |
This
description
can
be
used
to
capture
details
such
as
|
||||||||||||||||||||
| NamingSystem.useContext | |||||||||||||||||||||
|
| NamingSystem.useContext | ||||||||||||||||||||
| Definition |
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
|
||||||||||||||||||||
| Short Display | The context that the content is intended to support | ||||||||||||||||||||
|
|
0..* | ||||||||||||||||||||
| Type | UsageContext | ||||||||||||||||||||
| Requirements |
Assist in searching for appropriate content. |
||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| Comments |
When
multiple
useContexts
are
specified,
there
is
no
expectation
|
||||||||||||||||||||
| NamingSystem.jurisdiction | |||||||||||||||||||||
|
| NamingSystem.jurisdiction | ||||||||||||||||||||
| Definition |
A
legal
or
geographic
region
in
which
the
|
||||||||||||||||||||
| Short Display | Jurisdiction of the authority that maintains the naming system (if applicable) | ||||||||||||||||||||
|
|
0..* | ||||||||||||||||||||
| Terminology Binding |
Jurisdiction
ValueSet
(
Extensible
)
|
||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 Id | NamingSystem.purpose | ||||||||||||||||||||
| Definition | Explanation of why this naming system is needed and why it has been designed as it has. | ||||||||||||||||||||
| Short Display | Why this naming system is defined | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| 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 Id | NamingSystem.copyright | ||||||||||||||||||||
| Definition | 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. | ||||||||||||||||||||
| Short Display | Notice about intellectual property ownership, can include restrictions on use | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | markdown | ||||||||||||||||||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the naming system and/or its content. | ||||||||||||||||||||
| Alternate Names | License; Restrictions | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| NamingSystem.copyrightLabel | |||||||||||||||||||||
| Element Id | NamingSystem.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 restricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||||||||||||||
| Short Display | Copyright holder and year(s) | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments | The copyright symbol and the '(c)' textual representation 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 Id | NamingSystem.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 Display | When the NamingSystem was approved by publisher | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | date | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| 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 Id | NamingSystem.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 Display | When the NamingSystem was last reviewed by the publisher | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | date | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here . | ||||||||||||||||||||
| NamingSystem.effectivePeriod | |||||||||||||||||||||
| Element Id | NamingSystem.effectivePeriod | ||||||||||||||||||||
| Definition | The period during which the NamingSystem content was or is planned to be in active use. | ||||||||||||||||||||
| Short Display | When the NamingSystem is expected to be used | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | Period | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| Summary | true | ||||||||||||||||||||
| 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 | |||||||||||||||||||||
| Element Id | NamingSystem.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 Display | E.g. Education, Treatment, Assessment, etc | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Terminology Binding | Definition Topic ( Example ) | ||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||
| Requirements | Repositories must be able to determine how to categorize the NamingSystem so that it can be found by topical and keyword searches. | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| 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 Id | NamingSystem.author | ||||||||||||||||||||
| Definition | An individiual or organization primarily involved in the creation and maintenance of the NamingSystem. | ||||||||||||||||||||
| Short Display | Who authored the CodeSystem | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| NamingSystem.editor | |||||||||||||||||||||
| Element Id | NamingSystem.editor | ||||||||||||||||||||
| Definition | An individual or organization primarily responsible for internal coherence of the NamingSystem. | ||||||||||||||||||||
| Short Display | Who edited the NamingSystem | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| NamingSystem.reviewer | |||||||||||||||||||||
| Element Id | NamingSystem.reviewer | ||||||||||||||||||||
| Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem. | ||||||||||||||||||||
| Short Display | Who reviewed the NamingSystem | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments | See guidance around (not) making local changes to elements here . | ||||||||||||||||||||
| NamingSystem.endorser | |||||||||||||||||||||
| Element Id | NamingSystem.endorser | ||||||||||||||||||||
| Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting. | ||||||||||||||||||||
| Short Display | Who endorsed the NamingSystem | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | ContactDetail | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments | See guidance around (not) making local changes to elements here . | ||||||||||||||||||||
| NamingSystem.relatedArtifact | |||||||||||||||||||||
| Element Id | NamingSystem.relatedArtifact | ||||||||||||||||||||
| Definition |
Related
artifacts
such
as
additional
documentation,
justification,
dependencies,
bibliographic
references,
and
predecessor
and
successor
artifacts.
If
the
type
is
| ||||||||||||||||||||
| Short Display | Additional documentation, citations, etc | ||||||||||||||||||||
| Cardinality | 0..* | ||||||||||||||||||||
| Type | RelatedArtifact | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.usage | |||||||||||||||||||||
|
| NamingSystem.usage | ||||||||||||||||||||
| Definition |
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. |
||||||||||||||||||||
| Short Display | How/where is it used | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| NamingSystem.uniqueId | |||||||||||||||||||||
|
| NamingSystem.uniqueId | ||||||||||||||||||||
| Definition |
Indicates how the system may be identified when referenced in electronic exchange. |
||||||||||||||||||||
| Short Display | Unique identifiers used for system | ||||||||||||||||||||
| Cardinality | 1..* | ||||||||||||||||||||
|
| true | ||||||||||||||||||||
| Comments |
Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc. |
||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.uniqueId.type | |||||||||||||||||||||
|
| NamingSystem.uniqueId.type | ||||||||||||||||||||
| Definition |
Identifies the unique identifier scheme used for this particular identifier. |
||||||||||||||||||||
| Short Display | oid | uuid | uri | iri-stem | v2csmnemonic | other | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Terminology Binding |
|
||||||||||||||||||||
| Type | code | ||||||||||||||||||||
|
| true | ||||||||||||||||||||
| 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. |
||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.uniqueId.value | |||||||||||||||||||||
|
| NamingSystem.uniqueId.value | ||||||||||||||||||||
| Definition |
The string that should be sent over the wire to identify the code system or identifier system. |
||||||||||||||||||||
| Short Display | The unique identifier | ||||||||||||||||||||
| Cardinality | 1..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
|
|
true | ||||||||||||||||||||
| Comments |
If
the
value
is
a
URI
intended
for
use
as
FHIR
system
identifier,
the
URI
should
not
contain
|
||||||||||||||||||||
| NamingSystem.uniqueId.preferred | |||||||||||||||||||||
|
| NamingSystem.uniqueId.preferred | ||||||||||||||||||||
| Definition |
Indicates
whether
this
identifier
is
the
|
||||||||||||||||||||
| Short Display | Is this the id that should be used for this type | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||
| Meaning if Missing |
If
there
are
multiple
ids,
and
one
is
labeled
|
||||||||||||||||||||
| Summary | false | ||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
| NamingSystem.uniqueId.comment | |||||||||||||||||||||
|
| NamingSystem.uniqueId.comment | ||||||||||||||||||||
| Definition |
Notes about the past or intended usage of this identifier. |
||||||||||||||||||||
| Short Display | Notes about identifier usage | ||||||||||||||||||||
|
|
0..1 | ||||||||||||||||||||
| Type | string | ||||||||||||||||||||
|
| false | ||||||||||||||||||||
| Comments |
e.g.
|
||||||||||||||||||||
| NamingSystem.uniqueId.period | |||||||||||||||||||||
|
| NamingSystem.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 Display | When is identifier valid? | ||||||||||||||||||||
|
|
0..1 | ||||||||||||||||||||
| Type | Period | ||||||||||||||||||||
|
| false | ||||||||||||||||||||
| Comments |
Within
a
registry,
a
given
identifier
should
only
be
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. |
||||||||||||||||||||
| Constraints |
| ||||||||||||||||||||
|
|
|||||||||||||||||||||
|
| NamingSystem.uniqueId.authoritative | ||||||||||||||||||||
| Definition |
|
||||||||||||||||||||
| Short Display | Whether the identifier is authoritative | ||||||||||||||||||||
| Cardinality | 0..1 | ||||||||||||||||||||
| Type |
|
||||||||||||||||||||
|
|
false | ||||||||||||||||||||
| Constraints |
|
||||||||||||||||||||