FHIR
Infrastructure
![]() | Maturity Level : 1 | Trial Use | Security Category : Anonymous | Compartments : Not linked to any defined compartments |
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.
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.
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.
For
discussion
of
policy
for
creating
well
maintained
OIDs
and
URIs
for
resources,
see
The
HL7
Confluence
site
.
No resources refer to this resource directly.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
|
|
System
of
unique
identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Root systems cannot have uuid identifiers + Rule: Can't have more than one preferred identifier for a type Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright | |
![]() ![]() ![]() | Σ | 0..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique) |
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the naming system |
![]() ![]() ![]() | Σ I | 1..1 | string | Name for this naming system (computer friendly) |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
![]() ![]() ![]() | Σ | 1..1 | code |
codesystem
|
identifier
|
root
NamingSystemType ( Required ) |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() ![]() | 0..1 | string | Who maintains system namespace? | |
![]() ![]() ![]() | 0..1 | CodeableConcept |
e.g.
driver,
provider,
patient,
bank
etc.
IdentifierType ( Extensible ) | |
![]() ![]() ![]() | 0..1 | markdown | Natural language description of the naming system | |
![]() ![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
naming
system
(if
applicable)
Jurisdiction ( Extensible ) |
![]() ![]() ![]() | 0..1 | string | How/where is it used | |
![]() ![]() ![]() | Σ | 1..* | BackboneElement |
Unique
identifiers
used
for
system
|
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
oid
|
uuid
|
uri
|
other
NamingSystemIdentifierType ( Required ) |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The unique identifier |
![]() ![]() ![]() ![]() | 0..1 | boolean | Is this the id that should be used for this type | |
![]() ![]() ![]() ![]() | 0..1 | string | Notes about identifier usage | |
![]() ![]() ![]() ![]() | 0..1 | Period | When is identifier valid? | |
![]() |
UML Diagram ( Legend )
XML Template
<NamingSystem xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<!-- from --> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <version value="[string]"/><!-- 0..1 Business version of the naming system --> <name value="[string]"/><!--1..1 Name for this naming system (computer friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? --> <type><!-- 0..1 CodeableConcept e.g. driver, provider, patient, bank etc. --></type> <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <usage value="[string]"/><!-- 0..1 How/where is it used --> <uniqueId> <!-- 1..* Unique identifiers used for system --> <type value="[code]"/><!-- 1..1 oid | uuid | uri | other --> <value value="[string]"/><!-- 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- 0..1 Notes about identifier usage --> <period><!-- 0..1 Period When is identifier valid? --></period> </uniqueId> </NamingSystem>
JSON Template
{"resourceType" : "NamingSystem", // from Resource: id, meta, implicitRules, and language
// from ""url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique) "version" : "<string>", // Business version of the naming system "name" : "<string>", // C? R! Name for this naming system (computer friendly) "status" : "<code>", // R! draft | active | retired | unknown "kind" : "<code>", // R! codesystem | identifier | root "date" : "<dateTime>", // R! Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "responsible" : "<string>", // Who maintains system namespace? "type" : { CodeableConcept }, // e.g. driver, provider, patient, bank etc. "description" : "<markdown>", // Natural language description of the naming system "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for naming system (if applicable) "usage" : "<string>", // How/where is it used "uniqueId" : [{ // R! Unique identifiers used for system "type" : "<code>", // R! oid | uuid | uri | other "value" : "<string>", // R! The unique identifier "preferred" : <boolean>, // Is this the id that should be used for this type "comment" : "<string>", // Notes about identifier usage "period" : { Period } // When is identifier valid? }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:NamingSystem; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language
# fromfhir:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system fhir:NamingSystem.name [ string ]; # 1..1 Name for this naming system (computer friendly) fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace? fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver, provider, patient, bank etc. fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable) fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | other fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid? ], ...; ]
Changes since R3
NamingSystem | |
|
|
NamingSystem.version |
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors). )
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
|
|
System
of
unique
identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Root systems cannot have uuid identifiers + Rule: Can't have more than one preferred identifier for a type Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright | |
![]() ![]() ![]() | Σ | 0..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique) |
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the naming system |
![]() ![]() ![]() | Σ I | 1..1 | string | Name for this naming system (computer friendly) |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
![]() ![]() ![]() | Σ | 1..1 | code |
codesystem
|
identifier
|
root
NamingSystemType ( Required ) |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() ![]() | 0..1 | string | Who maintains system namespace? | |
![]() ![]() ![]() | 0..1 | CodeableConcept |
e.g.
driver,
provider,
patient,
bank
etc.
IdentifierType ( Extensible ) | |
![]() ![]() ![]() | 0..1 | markdown | Natural language description of the naming system | |
![]() ![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
naming
system
(if
applicable)
Jurisdiction ( Extensible ) |
![]() ![]() ![]() | 0..1 | string | How/where is it used | |
![]() ![]() ![]() | Σ | 1..* | BackboneElement |
Unique
identifiers
used
for
system
|
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
oid
|
uuid
|
uri
|
other
NamingSystemIdentifierType ( Required ) |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The unique identifier |
![]() ![]() ![]() ![]() | 0..1 | boolean | Is this the id that should be used for this type | |
![]() ![]() ![]() ![]() | 0..1 | string | Notes about identifier usage | |
![]() ![]() ![]() ![]() | 0..1 | Period | When is identifier valid? | |
![]() |
XML Template
<NamingSystem xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<!-- from --> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <version value="[string]"/><!-- 0..1 Business version of the naming system --> <name value="[string]"/><!--1..1 Name for this naming system (computer friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- 0..1 Who maintains system namespace? --> <type><!-- 0..1 CodeableConcept e.g. driver, provider, patient, bank etc. --></type> <description value="[markdown]"/><!-- 0..1 Natural language description of the naming system --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <usage value="[string]"/><!-- 0..1 How/where is it used --> <uniqueId> <!-- 1..* Unique identifiers used for system --> <type value="[code]"/><!-- 1..1 oid | uuid | uri | other --> <value value="[string]"/><!-- 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- 0..1 Notes about identifier usage --> <period><!-- 0..1 Period When is identifier valid? --></period> </uniqueId> </NamingSystem>
JSON Template
{"resourceType" : "NamingSystem", // from Resource: id, meta, implicitRules, and language
// from ""url" : "<uri>", // Canonical identifier for this naming system, represented as a URI (globally unique) "version" : "<string>", // Business version of the naming system "name" : "<string>", // C? R! Name for this naming system (computer friendly) "status" : "<code>", // R! draft | active | retired | unknown "kind" : "<code>", // R! codesystem | identifier | root "date" : "<dateTime>", // R! Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "responsible" : "<string>", // Who maintains system namespace? "type" : { CodeableConcept }, // e.g. driver, provider, patient, bank etc. "description" : "<markdown>", // Natural language description of the naming system "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for naming system (if applicable) "usage" : "<string>", // How/where is it used "uniqueId" : [{ // R! Unique identifiers used for system "type" : "<code>", // R! oid | uuid | uri | other "value" : "<string>", // R! The unique identifier "preferred" : <boolean>, // Is this the id that should be used for this type "comment" : "<string>", // Notes about identifier usage "period" : { Period } // When is identifier valid? }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:NamingSystem; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language
# fromfhir:NamingSystem.url [ uri ]; # 0..1 Canonical identifier for this naming system, represented as a URI (globally unique) fhir:NamingSystem.version [ string ]; # 0..1 Business version of the naming system fhir:NamingSystem.name [ string ]; # 1..1 Name for this naming system (computer friendly) fhir:NamingSystem.status [ code ]; # 1..1 draft | active | retired | unknown fhir:NamingSystem.kind [ code ]; # 1..1 codesystem | identifier | root fhir:NamingSystem.date [ dateTime ]; # 1..1 Date last changed fhir:NamingSystem.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:NamingSystem.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:NamingSystem.responsible [ string ]; # 0..1 Who maintains system namespace? fhir:NamingSystem.type [ CodeableConcept ]; # 0..1 e.g. driver, provider, patient, bank etc. fhir:NamingSystem.description [ markdown ]; # 0..1 Natural language description of the naming system fhir:NamingSystem.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:NamingSystem.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for naming system (if applicable) fhir:NamingSystem.usage [ string ]; # 0..1 How/where is it used fhir:NamingSystem.uniqueId [ # 1..* Unique identifiers used for system fhir:NamingSystem.uniqueId.type [ code ]; # 1..1 oid | uuid | uri | other fhir:NamingSystem.uniqueId.value [ string ]; # 1..1 The unique identifier fhir:NamingSystem.uniqueId.preferred [ boolean ]; # 0..1 Is this the id that should be used for this type fhir:NamingSystem.uniqueId.comment [ string ]; # 0..1 Notes about identifier usage fhir:NamingSystem.uniqueId.period [ Period ]; # 0..1 When is identifier valid? ], ...; ]
Changes since Release 3
NamingSystem | |
|
|
NamingSystem.version |
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. 1 fail round-trip testing and 3 r3 resources are invalid (0 errors). )
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
,
the
extensions
spreadsheet
version
&
the
dependency
analysis
a
Path | Definition | Type | Reference |
---|---|---|---|
NamingSystem.status | The lifecycle status of an artifact. | Required | PublicationStatus |
NamingSystem.kind | Identifies the purpose of the naming system. | Required | NamingSystemType |
NamingSystem.type | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Extensible | Identifier Type Codes |
NamingSystem.jurisdiction | Countries and regions within which this artifact is targeted for use. | Extensible | Jurisdiction ValueSet |
NamingSystem.uniqueId.type | Identifies the style of unique identifier used to identify a namespace. | Required | NamingSystemIdentifierType |
id | Level | Location | Description | Expression |
| Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
nsd-1 | Rule | (base) | Root systems cannot have uuid identifiers | kind != 'root' or uniqueId.all(type != 'uuid') |
nsd-2 | Rule | (base) | Can't have more than one preferred identifier for a type | uniqueId.where(preferred = true).select(type).isDistinct() |
In
some
cases,
the
same
code
or
identifier
system
might
accidentally
be
created
more
than
once
in
a
registry,
for
example
because
someone
failed
to
check
for
an
existing
entry
before
adding
a
new
one
or
knows
the
same
concept
with
a
different
name.
If
this
occurs,
one
of
the
system
entries
should
be
deleted
and
the
remaining
entry
should
have
its
uniqueId
updated
to
include
any
identifiers
present
on
the
original
entry
(and
possibly
have
its
descriptive
information
modified
to
include
additional
information
from
the
duplicate
entry).
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
contact N | string | Name of an individual to contact | NamingSystem.contact.name | |
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 | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the naming system |
On
NamingSystem.useContext:
context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value | composite | A use context type and value assigned to the naming system |
On
NamingSystem.useContext:
context-type: code context: value.as(CodeableConcept) | |
date N | date | The naming system publication date | NamingSystem.date | |
description N | string | The description of the naming system | NamingSystem.description | |
id-type N | token | oid | uuid | uri | other | NamingSystem.uniqueId.type | |
jurisdiction | token | Intended jurisdiction for the naming system | NamingSystem.jurisdiction | |
kind N | token | codesystem | identifier | root | NamingSystem.kind | |
name N | string | Computationally friendly name of the naming system | NamingSystem.name | |
period | date | When is identifier valid? | NamingSystem.uniqueId.period | |
publisher N | string | Name of the publisher of the naming system | NamingSystem.publisher | |
responsible N | string | Who maintains system namespace? | NamingSystem.responsible | |
status N | token | The current status of the naming system | NamingSystem.status | |
telecom | token | Contact details for individual or organization | NamingSystem.contact.telecom | |
type | token | e.g. driver, provider, patient, bank etc. | NamingSystem.type | |
url N | uri | The uri that identifies the naming system | NamingSystem.url | |
value N | string | The unique identifier | NamingSystem.uniqueId.value | |
version N | token | The business version of the naming system | NamingSystem.version |