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
Vocabulary
Work
Group
|
Maturity Level : 5 |
|
Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the CodeSystem resource.
| CodeSystem | |
| Element Id | CodeSystem |
| Definition |
|
| Control | 1..1 |
| Invariants |
Defined
on
this
element
csd-1 : Within a code system definition, all the codes SHALL be unique ( expression
:
(concept.code
|
descendants().concept.code).isDistinct(),
xpath:
count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept))
|
| CodeSystem.url | |
| Element Id | CodeSystem.url |
| Definition |
An
absolute
URI
that
is
used
to
identify
this
code
system
when
it
is
referenced
in
a
specification,
model,
design
or
an
|
| Control | 0..1 |
| Type | uri |
| Requirements |
Allows the code system to be referenced by a single globally unique identifier. |
| Summary | true |
| Comments |
Can
be
a
urn:uuid:
or
a
The URL SHOULD include the major version of the code system. For more information see Technical and Business Versions . |
| CodeSystem.identifier | |
| Element Id | CodeSystem.identifier |
| Definition |
A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance. |
| Note | This is a business identifer, not a resource identifier (see discussion ) |
| Control | 0..1 |
| Type | Identifier |
| Requirements |
Allows externally provided and/or usable business identifiers to be easily associated with the module. |
| Summary | true |
| Comments |
Typically,
this
is
used
for
identifiers
that
can
go
in
an
HL7
V3
II
(instance
identifier)
data
type,
|
| CodeSystem.version | |
| Element Id | CodeSystem.version |
| Definition |
The
identifier
that
is
used
to
identify
this
version
of
the
code
system
when
it
is
referenced
in
a
specification,
model,
design
or
instance.
This
is
an
arbitrary
value
managed
by
the
code
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.
This
is
used
in
|
| Note | This is a business versionId, not a resource version id (see discussion ) |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
There
may
be
different
code
system
instances
that
have
the
same
identifier
but
different
versions.
The
version
can
be
appended
to
the
url
in
a
reference
to
allow
a
|
| CodeSystem.name | |
| Element Id | CodeSystem.name |
| Definition |
A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Control | 0..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
|
| CodeSystem.title | |
| Element Id | CodeSystem.title |
| Definition |
A short, descriptive, user-friendly title for the code system. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
| CodeSystem.status | |
| Element Id | CodeSystem.status |
| Definition |
The status of this code 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
code
systems
that
are
appropriate
for
use
|
| CodeSystem.experimental | |
| Element Id | CodeSystem.experimental |
| Definition |
A
|
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true (Reason: null) |
| Requirements |
Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system. |
| Summary | true |
| Comments |
Allows
filtering
of
code
|
| CodeSystem.date | |
| Element Id | CodeSystem.date |
| Definition |
The
date
(and
optionally
time)
when
the
code
system
was
published.
The
date
must
change
|
| Control | 0..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 code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
| CodeSystem.publisher | |
| Element Id | CodeSystem.publisher |
| Definition |
The
name
of
the
|
| Control | 0..1 |
| Type | string |
| Requirements |
Helps
establish
the
|
| Summary | true |
| Comments |
Usually
an
|
| CodeSystem.contact | |
| Element Id | CodeSystem.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. |
| CodeSystem.description | |
| Element Id | CodeSystem.description |
| Definition |
A free text natural language description of the code system from a consumer's perspective. |
| Control | 0..1 |
| Type | markdown |
| Alternate Names | Scope; Purpose |
| Comments |
This description can be used to capture details such as why the code 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 code 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). |
| CodeSystem.useContext | |
| Standards Status | This element has a standards status of "Trial Use" which is different to the status of the whole resource |
| Element Id | CodeSystem.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 code 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
|
| CodeSystem.jurisdiction | |
| Element Id | CodeSystem.jurisdiction |
| Definition |
A legal or geographic region in which the code system is intended to be used. |
| Control | 0..* |
| Terminology Binding | Jurisdiction ValueSet ( Extensible ) |
| Type | CodeableConcept |
| Summary | true |
| Comments |
It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended. |
| CodeSystem.purpose | |
| Element Id | CodeSystem.purpose |
| Definition |
|
| Control | 0..1 |
| Type | markdown |
| Comments |
This
element
does
not
describe
the
usage
of
the
code
|
| CodeSystem.copyright | |
| Element Id | CodeSystem.copyright |
| Definition |
A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system. |
| Control | 0..1 |
| Type | markdown |
| Requirements |
Consumers must be able to determine any legal restrictions on the use of the code system and/or its content. |
| Alternate Names | License; Restrictions |
| Comments |
... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required. |
| CodeSystem.caseSensitive | |
| Element Id | CodeSystem.caseSensitive |
| Definition |
If code comparison is case sensitive when codes within this system are compared to each other. |
| Control | 0..1 |
| Type | boolean |
| Summary | true |
| Comments |
If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software. |
| CodeSystem.valueSet | |
| Element Id | CodeSystem.valueSet |
| Definition |
Canonical URL of value set that contains the entire code system. |
| Control | 0..1 |
| Type |
|
| Summary | true |
| Comments |
The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable. |
| CodeSystem.hierarchyMeaning | |
| Element Id | CodeSystem.hierarchyMeaning |
| Definition |
The meaning of the hierarchy of concepts. |
| Control | 0..1 |
| Terminology Binding | CodeSystemHierarchyMeaning ( Required ) |
| Type | code |
| Summary | true |
| CodeSystem.compositional | |
| Element Id | CodeSystem.compositional |
| Definition |
True If code system defines a post-composition grammar. |
| Control | 0..1 |
| Type | boolean |
| Alternate Names | grammar |
| Summary | true |
| Comments |
Note that the code system resource does not define what the compositional grammar is, only whether or not there is one. |
| CodeSystem.versionNeeded | |
| Element Id | CodeSystem.versionNeeded |
| Definition |
This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system. |
| Control | 0..1 |
| Type | boolean |
| Summary | true |
| Comments |
Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'. |
| CodeSystem.content | |
| Element Id | CodeSystem.content |
| Definition |
How much of the content of the code system - the concepts and codes it defines - are represented in this resource. |
| Control | 1..1 |
| Terminology Binding | CodeSystemContentMode ( Required ) |
| Type | code |
| Summary | true |
| CodeSystem.supplements | |
| Element Id | CodeSystem.supplements |
| Definition | References the code system that this code system supplement is adding designations and properties to. |
| Control | 0..1 |
| Type | canonical ( CodeSystem ) |
| Summary | true |
| Comments | The most common use of a code system supplement is to add additional language support. |
| CodeSystem.count | |
| Element Id | CodeSystem.count |
| Definition |
The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts. |
| Control | 0..1 |
| Type | unsignedInt |
| Summary | true |
| Comments |
The
count
of
concepts
defined
in
this
resource
cannot
be
more
than
this
|
| CodeSystem.filter | |
| Element Id | CodeSystem.filter |
| Definition |
A filter that can be used in a value set compose statement when selecting concepts using a filter. |
| Control | 0..* |
| Summary | true |
| CodeSystem.filter.code | |
| Element Id | CodeSystem.filter.code |
| Definition |
The code that identifies this filter when it is used in the instance. |
| Control | 1..1 |
| Type | code |
| Summary | true |
| CodeSystem.filter.description | |
| Element Id | CodeSystem.filter.description |
| Definition |
A description of how or why the filter is used. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| CodeSystem.filter.operator | |
| Element Id | CodeSystem.filter.operator |
| Definition |
A list of operators that can be used with the filter. |
| Control | 1..* |
| Terminology Binding | FilterOperator ( Required ) |
| Type | code |
| Summary | true |
| CodeSystem.filter.value | |
| Element Id | CodeSystem.filter.value |
| Definition |
A description of what the value for the filter should be. |
| Control | 1..1 |
| Type | string |
| Summary | true |
| CodeSystem.property | |
| Element Id | CodeSystem.property |
| Definition |
A property defines an additional slot through which additional information can be provided about a concept. |
| Control | 0..* |
| Summary | true |
| CodeSystem.property.code | |
| Element Id | CodeSystem.property.code |
| Definition |
A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters. |
| Control | 1..1 |
| Type | code |
| Summary | true |
| CodeSystem.property.uri | |
| Element Id | CodeSystem.property.uri |
| Definition |
Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system. |
| Control | 0..1 |
| Type | uri |
| Summary | true |
| CodeSystem.property.description | |
| Element Id | CodeSystem.property.description |
| Definition |
A description of the property- why it is defined, and how its value might be used. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| CodeSystem.property.type | |
| Element Id | CodeSystem.property.type |
| Definition |
The
type
of
the
property
value.
Properties
of
type
|
| Control | 1..1 |
| Terminology Binding | PropertyType ( Required ) |
| Type | code |
| Summary | true |
| CodeSystem.concept | |
| Element Id | CodeSystem.concept |
| Definition |
Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are. |
| Control | 0..* |
| Comments |
If this is empty, it means that the code system resource does not represent the content of the code system. |
| CodeSystem.concept.code | |
| Element Id | CodeSystem.concept.code |
| Definition |
A code - a text symbol - that uniquely identifies the concept within the code system. |
| Control | 1..1 |
| Type | code |
| CodeSystem.concept.display | |
| Element Id | CodeSystem.concept.display |
| Definition |
A human readable string that is the recommended default way to present this concept to a user. |
| Control | 0..1 |
| Type | string |
| CodeSystem.concept.definition | |
| Element Id | CodeSystem.concept.definition |
| Definition |
The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept. |
| Control | 0..1 |
| Type | string |
| CodeSystem.concept.designation | |
| Element Id | CodeSystem.concept.designation |
| Definition |
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. |
| Control | 0..* |
| Requirements |
Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. |
| CodeSystem.concept.designation.language | |
| Element Id | CodeSystem.concept.designation.language |
| Definition |
The language this designation is defined for. |
| Control | 0..1 |
| Terminology Binding | Common Languages ( Extensible but limited to ??) |
| Type | code |
| Comments |
In the absence of a language, the resource language applies. |
| CodeSystem.concept.designation.use | |
| Element Id | CodeSystem.concept.designation.use |
| Definition |
A code that details how this designation would be used. |
| Control | 0..1 |
| Terminology Binding | Designation Use ( Extensible ) |
| Type | Coding |
| Comments |
If no use is provided, the designation can be assumed to be suitable for general display to a human user. |
| CodeSystem.concept.designation.value | |
| Element Id | CodeSystem.concept.designation.value |
| Definition |
The text value for this designation. |
| Control | 1..1 |
| Type | string |
| CodeSystem.concept.property | |
| Element Id | CodeSystem.concept.property |
| Definition |
A property value for this concept. |
| Control | 0..* |
| CodeSystem.concept.property.code | |
| Element Id | CodeSystem.concept.property.code |
| Definition |
A code that is a reference to CodeSystem.property.code. |
| Control | 1..1 |
| Type | code |
| CodeSystem.concept.property.value[x] | |
| Element Id | CodeSystem.concept.property.value[x] |
| Definition |
The value of this property. |
| Control | 1..1 |
| Type | code | Coding | string | integer | boolean | dateTime | decimal |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| CodeSystem.concept.concept | |
| Element Id | CodeSystem.concept.concept |
| Definition |
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning. |
| Control | 0..* |
| Type | See CodeSystem.concept |