Terminology
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
|
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 the identifier.
The
CodeSystem
resource defines the content of a code system, and also it's preferred identifier. The
NamingSystem
resource identifies the existence of a code or idenifier system, and it's 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 dsscribe 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 systemn, but there should only be one
CodeSystem
resource.
For discussion of policy for creating well maintained OIDs and URIs for resources, see
The HL7 WIKI
.
.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
NamingSystem
|
I | DomainResource |
|
|
name
|
1..1 | string |
|
|
|
status
|
?! Σ | 1..1 | code |
ConformanceResourceStatus |
|
kind
|
1..1 | code |
NamingSystemType |
|
|
date
|
Σ | 1..1 | dateTime | Publication Date(/time) |
|
publisher
| Σ | 0..1 | string |
|
contact
|
Σ | 0..* | BackboneElement |
|
name
|
Σ | 0..1 | string |
|
telecom
|
Σ | 0..* | ContactPoint |
|
|
responsible
|
0..1 | string |
|
|
|
type
|
0..1 | CodeableConcept |
|
|
|
description
|
0..1 |
|
|
|
|
useContext
|
Σ | 0..* | CodeableConcept |
|
|
usage
|
0..1 | string |
|
|
|
uniqueId
|
1..* | BackboneElement |
|
|
|
type
|
1..1 | code |
NamingSystemIdentifierType |
|
|
value
|
1..1 | string |
|
|
|
preferred
|
0..1 | boolean |
|
|
|
comment
| 0..1 | string | Notes about identifier usage | |
|
period
|
0..1 | Period |
|
|
replacedBy
|
I | 0..1 | Reference ( NamingSystem ) |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<NamingSystem xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< < < < < < <</telecom><name value="[string]"/><!-- 1..1 Human-readable label --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact>< < <</type> < <</useContext> < < < < < <</period><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 What does naming system identify? --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <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><</replacedBy><replacedBy><!--0..1 Reference(NamingSystem) Use this instead --></replacedBy> </NamingSystem>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "NamingSystem",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"name" : "<string>", // R! Human-readable label
"status" : "<code>", // R! draft | active | retired
"kind" : "<code>", // R! codesystem | identifier | root
"date" : "<dateTime>", // R! Publication Date(/time)
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"
"
"
"
"
"
"
"
"
"
"responsible" : "<string>", // Who maintains system namespace?
"type" : { CodeableConcept }, // e.g. driver, provider, patient, bank etc.
"description" : "<markdown>", // What does naming system identify?
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"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?
}],
"
"replacedBy" : { Reference(NamingSystem) } // C? Use this instead
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| NamingSystem | |
| NamingSystem.description | Type changed from string to markdown |
| NamingSystem.uniqueId.comment | added |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
NamingSystem
|
I | DomainResource |
|
|
|
name
|
1..1 | string |
|
|
|
status
|
?! Σ | 1..1 | code |
ConformanceResourceStatus |
|
kind
|
1..1 | code |
NamingSystemType |
|
|
date
|
Σ | 1..1 | dateTime | Publication Date(/time) |
|
publisher
| Σ | 0..1 | string |
|
|
contact
|
Σ | 0..* | BackboneElement |
|
|
name
|
Σ | 0..1 | string |
|
|
telecom
|
Σ | 0..* | ContactPoint |
|
|
responsible
|
0..1 | string |
|
|
|
type
|
0..1 | CodeableConcept |
|
|
|
description
|
0..1 |
|
|
|
|
useContext
|
Σ | 0..* | CodeableConcept |
|
|
usage
|
0..1 | string |
|
|
|
uniqueId
|
1..* | BackboneElement |
|
|
|
type
|
1..1 | code |
NamingSystemIdentifierType |
|
|
value
|
1..1 | string |
|
|
|
preferred
|
0..1 | boolean |
|
|
|
comment
| 0..1 | string | Notes about identifier usage | |
|
period
|
0..1 | Period |
|
|
|
replacedBy
|
I | 0..1 | Reference ( NamingSystem ) |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<NamingSystem xmlns="http://hl7.org/fhir">< < < < < < <</telecom><name value="[string]"/><!-- 1..1 Human-readable label --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <kind value="[code]"/><!-- 1..1 codesystem | identifier | root --> <date value="[dateTime]"/><!-- 1..1 Publication Date(/time) --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact> <!-- 0..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact>< < <</type> < <</useContext> < < < < < <</period><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 What does naming system identify? --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <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><</replacedBy><replacedBy><!--
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "NamingSystem",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"name" : "<string>", // R! Human-readable label
"status" : "<code>", // R! draft | active | retired
"kind" : "<code>", // R! codesystem | identifier | root
"date" : "<dateTime>", // R! Publication Date(/time)
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"
"
"
"
"
"
"
"
"
"
"responsible" : "<string>", // Who maintains system namespace?
"type" : { CodeableConcept }, // e.g. driver, provider, patient, bank etc.
"description" : "<markdown>", // What does naming system identify?
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"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?
}],
"
"replacedBy" : { Reference(NamingSystem) } // C? Use this instead
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| NamingSystem | |
| NamingSystem.description | Type changed from string to markdown |
| NamingSystem.uniqueId.comment | added |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| NamingSystem.status |
|
Required | ConformanceResourceStatus |
| NamingSystem.kind |
|
Required | NamingSystemType |
| NamingSystem.type |
|
Extensible |
|
| NamingSystem.useContext |
|
Extensible |
|
| NamingSystem.uniqueId.type |
|
Required | NamingSystemIdentifierType |
:
kind != 'root' or uniqueId.type = 'uuid'
)
:
uniqueId.where(preferred = true).select(type).isDistinct()
)
:
replacedBy.empty() or status = 'retired'
)
In some cases, the same code or identifier system might accidentally get created more than once in a registry (perhaps 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 information updated to include any identifiers present on the original entry (and possibly have its descriptive information modified to include additional information gleaned 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.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| contact | string |
|
NamingSystem.contact.name |
| context | token |
|
NamingSystem.useContext |
| date | date |
|
NamingSystem.date |
| id-type | token |
|
NamingSystem.uniqueId.type |
| kind | token |
|
NamingSystem.kind |
| name | string |
|
NamingSystem.name |
| period | date |
|
NamingSystem.uniqueId.period |
| publisher | string |
|
NamingSystem.publisher |
| replaced-by | reference |
|
NamingSystem.replacedBy
( NamingSystem ) |
| responsible | string |
|
NamingSystem.responsible |
| status | token |
|
NamingSystem.status |
| telecom | token |
|
NamingSystem.contact.telecom |
| type | token |
|
NamingSystem.type |
| value | string |
|
NamingSystem.uniqueId.value |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change