This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.3.0:
R4
Ballot
2).
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
Group
|
Maturity Level : 1 | Trial Use | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the NamingSystem resource.
| NamingSystem | |
| Element Id | NamingSystem |
| Definition |
A
curated
namespace
that
issues
unique
symbols
within
that
namespace
for
the
identification
of
concepts,
people,
devices,
etc.
Represents
a
|
| Control | 1..1 |
| Invariants |
Defined
on
this
element
nsd-1 : Root systems cannot have uuid identifiers ( expression
:
kind
!=
'root'
or
nsd-2 : Can't have more than one preferred identifier for a type ( expression
:
uniqueId.where(preferred
=
true).select(type).isDistinct(),
xpath:
not(exists(for
$type
in
distinct-values(f:uniqueId/f:type/@value)
return
if
(count(f:uniqueId[f:type/@value=$type
and
f:preferred/@value=true()])>1)
then
$type
else
())))
|
| NamingSystem.name | |
| Element Id | 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. |
| Control | 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
|
| NamingSystem.status | |
| Element Id | NamingSystem.status |
| Definition |
The status of this naming system. Enables tracking the life-cycle of the content. |
| Control | 1..1 |
| Terminology Binding | PublicationStatus ( Required ) |
| Type | code |
| Is Modifier | true (Reason: null) |
| Summary | true |
| Comments |
Allows
filtering
of
naming
systems
that
are
appropriate
for
use
|
| NamingSystem.kind | |
| Element Id | NamingSystem.kind |
| Definition |
Indicates the purpose for the naming system - what kinds of things does it make unique? |
| Control | 1..1 |
| Terminology Binding | NamingSystemType ( Required ) |
| Type | code |
| Summary | true |
| NamingSystem.date | |
| Element Id | NamingSystem.date |
| Definition |
The
date
(and
optionally
time)
when
the
naming
system
was
published.
The
date
must
change
|
| Control | 1..1 |
| Type | dateTime |
| Alternate Names | Revision Date |
| Summary | true |
| 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 Id | NamingSystem.publisher |
| Definition |
The
name
of
the
|
| Control | 0..1 |
| Type | string |
| Requirements |
Helps
establish
the
|
| Summary | true |
| Comments |
Usually
an
|
| NamingSystem.contact | |
| Element Id | NamingSystem.contact |
| Definition |
Contact details to assist a user in finding and communicating with the publisher. |
| Control | 0..* |
| Type | ContactDetail |
| Summary | true |
| Comments |
May be a web site, an email address, a telephone number, etc. |
| NamingSystem.responsible | |
| Element Id | NamingSystem.responsible |
| Definition |
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. |
| Control | 0..1 |
| Type | string |
| Comments |
This is the primary organization. Responsibility for some aspects of a namespace may be delegated. |
| NamingSystem.type | |
| Element Id | NamingSystem.type |
| Definition |
Categorizes a naming system for easier search by grouping related naming systems. |
| Control | 0..1 |
| Terminology Binding | Identifier Type Codes ( Extensible ) |
| Type | CodeableConcept |
| 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 Id | 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. |
| Control | 0..1 |
| Type | markdown |
| 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 profile is presumed to be the predominant language in the place the profile was created). |
| NamingSystem.useContext | |
| Element Id | NamingSystem.useContext |
| Definition |
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances. |
| Control | 0..* |
| Type | UsageContext |
| Requirements |
Assist in searching for appropriate content. |
| Summary | true |
| Comments |
When
multiple
useContexts
are
specified,
there
is
no
expectation
|
| NamingSystem.jurisdiction | |
| Element Id | NamingSystem.jurisdiction |
| Definition |
A legal or geographic region in which the naming system is intended to be used. |
| Control | 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. |
| NamingSystem.usage | |
| Element Id | NamingSystem.usage |
| Definition |
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. |
| Control | 0..1 |
| Type | string |
| NamingSystem.uniqueId | |
| Element Id | NamingSystem.uniqueId |
| Definition |
Indicates how the system may be identified when referenced in electronic exchange. |
| Control | 1..* |
| Summary | true |
| Comments |
Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc. |
| NamingSystem.uniqueId.type | |
| Element Id | NamingSystem.uniqueId.type |
| Definition |
Identifies the unique identifier scheme used for this particular identifier. |
| Control | 1..1 |
| Terminology Binding | NamingSystemIdentifierType ( Required ) |
| Type | code |
| Summary | 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. |
| NamingSystem.uniqueId.value | |
| Element Id | NamingSystem.uniqueId.value |
| Definition |
The string that should be sent over the wire to identify the code system or identifier system. |
| Control | 1..1 |
| Type | string |
| Summary | true |
| Comments |
If
the
value
is
a
URI
intended
for
use
as
FHIR
system
identifier,
the
URI
should
not
contain
|
| NamingSystem.uniqueId.preferred | |
| Element Id | NamingSystem.uniqueId.preferred |
| Definition |
Indicates
whether
this
identifier
is
the
|
| Control | 0..1 |
| Type | boolean |
| Meaning if Missing |
If
there
are
multiple
ids,
and
one
is
labeled
|
| NamingSystem.uniqueId.comment | |
| Element Id | NamingSystem.uniqueId.comment |
| Definition |
Notes about the past or intended usage of this identifier. |
| Control | 0..1 |
| Type | string |
| Comments |
e.g.
|
| NamingSystem.uniqueId.period | |
| Element Id | 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. |
| Control | 0..1 |
| Type | Period |
| Comments |
Within
a
registry,
a
given
identifier
should
only
be
|