This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Terminology
Infrastructure
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/publishablecodesystem
Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management
implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This
profile
was
published
on
Thu,
Jan
1,
1970
00:00+1000
00:00+0800
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from ShareableCodeSystem .
Summary
Mandatory:
1
element
Must-Support:
10
elements
Extensions
This structure refers to these extensions:
This indicates the differences between this profile and the base ShareableCodeSystem structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableCodeSystem | Declares the existence of and describes a code system or code system supplement | |
|
|
Content/Rules for all slices | ||
![]() ![]() ![]() | 0..1 | uri |
Where
did
this
content
come
from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
|
|
0..* | (Complex) |
Alternative
names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName |
|
|
S | 0 .. * | Identifier | Additional identifier for the code system (business identifier) |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for code system (if applicable) |
|
S | 0 .. 1 | markdown | Why this code system is defined |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
0 .. 1 | date | When the CodeSystem was approved by publisher | |
|
0 .. 1 | date | When the CodeSystem was last reviewed by the publisher | |
|
S | 0 .. 1 | Period | When the CodeSystem is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment, etc |
|
0 .. * | ContactDetail | Who authored the CodeSystem | |
|
0 .. * | ContactDetail | Who edited the CodeSystem | |
|
0 .. * | ContactDetail | Who reviewed the CodeSystem | |
|
0 .. * | ContactDetail | Who endorsed the CodeSystem | |
|
0 .. * | RelatedArtifact | Additional documentation, citations, etc | |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableCodeSystem structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableCodeSystem |
Declares
the
existence
of
and
describes
a
code
system
or
code
system
supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
0..1 | uri |
Where
did
this
content
come
from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
|||||
|
0..* | (Complex) |
Alternative
names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName |
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
code
system,
represented
as
a
URI
(globally
unique)
(Coding.system)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
code
system
(business
identifier)
|
||||
|
S Σ | 1..1 | string | Business version of the code system (Coding.version) | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this code system (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this code system (human friendly) | ||||
|
?! S Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S | 1..1 | markdown | Natural language description of the code system | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
S Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
code
system
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
S | 0..1 | markdown | Why this code system is defined | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
0..1 | date | When the CodeSystem was approved by publisher | |||||
|
0..1 | date | When the CodeSystem was last reviewed by the publisher | |||||
|
S Σ | 0..1 | Period | When the CodeSystem is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ) |
||||
|
0..* | ContactDetail |
Who
authored
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
edited
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
reviewed
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
endorsed
the
CodeSystem
|
|||||
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
|||||
|
S Σ | 1..1 | boolean | If code comparison is case sensitive | ||||
|
Σ | 0..1 | canonical ( ValueSet ) | Canonical reference to the value set with entire code system | ||||
|
S
Σ
C
|
0..1 | code |
grouped-by
|
is-a
|
part-of
|
classified-with
Binding: Code System Hierarchy Meaning ( required ): The meaning of the hierarchy of concepts in a code system. |
||||
|
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
|
Σ | 0..1 | boolean | If definitions are not stable | ||||
|
S
Σ
C
|
1..1 | code |
not-present
|
example
|
fragment
|
complete
|
supplement
Binding: Code System Content Mode ( required ): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. |
||||
|
Σ
C
|
0..1 | canonical ( CodeSystem ) | Canonical URL of Code System this adds designations and properties to | ||||
|
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
|
Σ | 0..* | BackboneElement |
Filter
that
can
be
used
in
a
value
set
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | code | Code that identifies the filter | ||||
|
Σ | 0..1 | string | How or why the filter is used | ||||
|
Σ | 1..* | code |
=
|
is-a
|
descendent-of
|
is-not-a
|
regex
|
in
|
not-in
|
generalizes
|
child-of
|
descendent-leaf
|
exists
Binding: Filter Operator ( required ): The kind of operation to perform as a part of a property based filter. |
||||
|
Σ | 1..1 | string | What to use for the value | ||||
|
Σ | 0..* | BackboneElement |
Additional
information
supplied
about
each
concept
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
|
Σ | 0..1 | uri | Formal identifier for the property | ||||
|
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
|
Σ | 1..1 | code |
code
|
Coding
|
string
|
integer
|
boolean
|
dateTime
|
decimal
Binding: Property Type ( required ): The type of a property value. |
||||
|
S
C
|
0..* | BackboneElement |
Concepts
in
the
code
system
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
S
C
|
1..1 | code | Code that identifies concept | ||||
|
S | 0..1 | string | Text to display to the user | ||||
|
S | 0..1 | string | Formal definition | ||||
|
C
|
0..* | BackboneElement |
Additional
representations
for
the
concept
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
Human
language
of
the
designation
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
C
|
0..1 | Coding |
Details
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
C
|
0..* | Coding |
Additional
ways
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
1..1 | string | The text value for this designation | |||||
|
0..* | BackboneElement |
Property
value
for
the
concept
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
|
1..1 | code | Reference to CodeSystem.property.code | ||||
|
1..1 | Value of the property for this concept | ||||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
S
C
|
0..* | See concept (CodeSystem) |
Child
Concepts
(is-a/contains/categorizes)
|
||||
|
||||||||
<!-- PublishableCodeSystem --><CodeSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishablecodesystem-definitions.html#CodeSystem.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) --> <identifier><!-- I 0..* Identifier Additional identifier for the code system (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the code system (Coding.version) --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this code system (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this code system (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the code system --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for code system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this code system is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the CodeSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the CodeSystem was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the CodeSystem is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- I 0..* ContactDetail Who edited the CodeSystem --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the CodeSystem --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the CodeSystem --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <caseSensitive value="[boolean]"/><!-- I 1..1 If code comparison is case sensitive --> <valueSet value="[canonical]"/><!-- I 0..1 Canonical reference to the value set with entire code system --> <hierarchyMeaning value="[code]"/><!-- I 0..1 grouped-by | is-a | part-of | classified-with --> <compositional value="[boolean]"/><!-- I 0..1 If code system defines a compositional grammar --> <versionNeeded value="[boolean]"/><!-- I 0..1 If definitions are not stable --> <content value="[code]"/><!-- I 1..1 not-present | example | fragment | complete | supplement --> <supplements value="[canonical]"/><!-- I 0..1 Canonical URL of Code System this adds designations and properties to --> <count value="[unsignedInt]"/><!-- I 0..1 Total concepts in the code system --> <filter> I 0..* BackboneElement <!-- I 0..* Filter that can be used in a value set --><<a href="publishablecodesystem-definitions.html#CodeSystem.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code that identifies the filter --> <description value="[string]"/><!-- I 0..1 How or why the filter is used --> <operator value="[code]"/><!-- I 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists --> <value value="[string]"/><!-- I 1..1 What to use for the value --> </filter> <property> I 0..* BackboneElement <!-- I 0..* Additional information supplied about each concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property --> <description value="[string]"/><!-- I 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- I 1..1 code | Coding | string | integer | boolean | dateTime | decimal --> </property> <concept> I 0..* BackboneElement <!-- I 0..* Concepts in the code system --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code that identifies concept --> <display value="[string]"/><!-- I 0..1 Text to display to the user --> <definition value="[string]"/><!-- I 0..1 Formal definition --> <designation> I 0..* BackboneElement <!-- I 0..* Additional representations for the concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- I 0..1 Human language of the designation --> <use><!-- I 0..1 Coding Details how this designation would be used --></use> <additionalUse><!-- I 0..* Coding Additional ways how this designation would be used --></additionalUse> <value value="[string]"/><!-- I 1..1 The text value for this designation --> </designation> <property> I 0..* BackboneElement <!-- I 0..* Property value for the concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to CodeSystem.property.code --> <value[x]><!-- I 1..1 code|Coding|string|integer| boolean|dateTime|decimal Value of the property for this concept --></value[x]> </property> <concept><!-- See http://hl7.org/fhir/StructureDefinition/CodeSystem#CodeSystem.concept Child Concepts (is-a/contains/categorizes) --></concept> </concept> </CodeSystem>
{ // PublishableCodeSystem
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ //
{ // Where did this content come from // I
// from Element: extension
},
{ //
{ // Alternative names // I
// from Element: extension
}
],
"<a href="publishablecodesystem-definitions.html#CodeSystem.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
"identifier" : [{ Identifier }], // IAdditional identifier for the code system (business identifier)
"version" : "<string>", // I R! Business version of the code system (Coding.version)
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this code system (computer friendly)
"title" : "<string>", // I R! Name for this code system (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the code system
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for code system (if applicable)
"purpose" : "<markdown>", // IWhy this code system is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the CodeSystem was approved by publisher
"lastReviewDate" : "<date>", // IWhen the CodeSystem was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the CodeSystem is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the CodeSystem
"editor" : [{ ContactDetail }], // IWho edited the CodeSystem
"reviewer" : [{ ContactDetail }], // IWho reviewed the CodeSystem
"endorser" : [{ ContactDetail }], // IWho endorsed the CodeSystem
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"caseSensitive" : <boolean>, // I R! If code comparison is case sensitive
"valueSet" : "<canonical>", // ICanonical reference to the value set with entire code system
"hierarchyMeaning" : "<code>", // Igrouped-by | is-a | part-of | classified-with
"compositional" : <boolean>, // IIf code system defines a compositional grammar
"versionNeeded" : <boolean>, // IIf definitions are not stable
"content" : "<code>", // I R! not-present | example | fragment | complete | supplement
"supplements" : "<canonical>", // ICanonical URL of Code System this adds designations and properties to
"count" : "<unsignedInt>", // ITotal concepts in the code system
"filter" : [{ BackboneElement }], // IFilter that can be used in a value set
"property" : [{ BackboneElement }], // IAdditional information supplied about each concept
"concept" : [{ BackboneElement }], // IConcepts in the code system
}
This structure is derived from ShareableCodeSystem .
Differential View
This indicates the differences between this profile and the base ShareableCodeSystem structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableCodeSystem | Declares the existence of and describes a code system or code system supplement | |
|
|
Content/Rules for all slices | ||
![]() ![]() ![]() | 0..1 | uri |
Where
did
this
content
come
from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
|
|
0..* | (Complex) |
Alternative
names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName |
|
|
S | 0 .. * | Identifier | Additional identifier for the code system (business identifier) |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for code system (if applicable) |
|
S | 0 .. 1 | markdown | Why this code system is defined |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
0 .. 1 | date | When the CodeSystem was approved by publisher | |
|
0 .. 1 | date | When the CodeSystem was last reviewed by the publisher | |
|
S | 0 .. 1 | Period | When the CodeSystem is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment, etc |
|
0 .. * | ContactDetail | Who authored the CodeSystem | |
|
0 .. * | ContactDetail | Who edited the CodeSystem | |
|
0 .. * | ContactDetail | Who reviewed the CodeSystem | |
|
0 .. * | ContactDetail | Who endorsed the CodeSystem | |
|
0 .. * | RelatedArtifact | Additional documentation, citations, etc | |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableCodeSystem structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableCodeSystem |
Declares
the
existence
of
and
describes
a
code
system
or
code
system
supplement
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation csd-1: Within a code system definition, all the codes SHALL be unique csd-2: If there is an explicit hierarchy, a hierarchyMeaning should be provided csd-3: If there is an implicit hierarchy, a hierarchyMeaning should be provided csd-4: If the code system content = supplement, it must nominate what it's a supplement for scs-1: If a codesystem contains nested concepts, it must specify hierarchyMeaning scs-2: If a codesystem contains example, fragment, or complete content, it must have at least one concept |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
0..1 | uri |
Where
did
this
content
come
from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
|||||
|
0..* | (Complex) |
Alternative
names
URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName |
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
code
system,
represented
as
a
URI
(globally
unique)
(Coding.system)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
code
system
(business
identifier)
|
||||
|
S Σ | 1..1 | string | Business version of the code system (Coding.version) | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this code system (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this code system (human friendly) | ||||
|
?! S Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S | 1..1 | markdown | Natural language description of the code system | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
S Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
code
system
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
||||
|
S | 0..1 | markdown | Why this code system is defined | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
0..1 | date | When the CodeSystem was approved by publisher | |||||
|
0..1 | date | When the CodeSystem was last reviewed by the publisher | |||||
|
S Σ | 0..1 | Period | When the CodeSystem is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ) |
||||
|
0..* | ContactDetail |
Who
authored
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
edited
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
reviewed
the
CodeSystem
|
|||||
|
0..* | ContactDetail |
Who
endorsed
the
CodeSystem
|
|||||
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
|||||
|
S Σ | 1..1 | boolean | If code comparison is case sensitive | ||||
|
Σ | 0..1 | canonical ( ValueSet ) | Canonical reference to the value set with entire code system | ||||
|
S
Σ
C
|
0..1 | code |
grouped-by
|
is-a
|
part-of
|
classified-with
Binding: Code System Hierarchy Meaning ( required ): The meaning of the hierarchy of concepts in a code system. |
||||
|
Σ | 0..1 | boolean | If code system defines a compositional grammar | ||||
|
Σ | 0..1 | boolean | If definitions are not stable | ||||
|
S
Σ
C
|
1..1 | code |
not-present
|
example
|
fragment
|
complete
|
supplement
Binding: Code System Content Mode ( required ): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. |
||||
|
Σ
C
|
0..1 | canonical ( CodeSystem ) | Canonical URL of Code System this adds designations and properties to | ||||
|
Σ | 0..1 | unsignedInt | Total concepts in the code system | ||||
|
Σ | 0..* | BackboneElement |
Filter
that
can
be
used
in
a
value
set
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | code | Code that identifies the filter | ||||
|
Σ | 0..1 | string | How or why the filter is used | ||||
|
Σ | 1..* | code |
=
|
is-a
|
descendent-of
|
is-not-a
|
regex
|
in
|
not-in
|
generalizes
|
child-of
|
descendent-leaf
|
exists
Binding: Filter Operator ( required ): The kind of operation to perform as a part of a property based filter. |
||||
|
Σ | 1..1 | string | What to use for the value | ||||
|
Σ | 0..* | BackboneElement |
Additional
information
supplied
about
each
concept
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||
|
Σ | 0..1 | uri | Formal identifier for the property | ||||
|
Σ | 0..1 | string | Why the property is defined, and/or what it conveys | ||||
|
Σ | 1..1 | code |
code
|
Coding
|
string
|
integer
|
boolean
|
dateTime
|
decimal
Binding: Property Type ( required ): The type of a property value. |
||||
|
S
C
|
0..* | BackboneElement |
Concepts
in
the
code
system
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
S
C
|
1..1 | code | Code that identifies concept | ||||
|
S | 0..1 | string | Text to display to the user | ||||
|
S | 0..1 | string | Formal definition | ||||
|
C
|
0..* | BackboneElement |
Additional
representations
for
the
concept
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
Human
language
of
the
designation
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
C
|
0..1 | Coding |
Details
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
C
|
0..* | Coding |
Additional
ways
how
this
designation
would
be
used
Binding: Designation Use ( extensible ): Details of how a designation would be used. |
||||
|
1..1 | string | The text value for this designation | |||||
|
0..* | BackboneElement |
Property
value
for
the
concept
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
C
|
1..1 | code | Reference to CodeSystem.property.code | ||||
|
1..1 | Value of the property for this concept | ||||||
|
code | |||||||
|
Coding | |||||||
|
string | |||||||
|
integer | |||||||
|
boolean | |||||||
|
dateTime | |||||||
|
decimal | |||||||
|
S
C
|
0..* | See concept (CodeSystem) |
Child
Concepts
(is-a/contains/categorizes)
|
||||
|
||||||||
XML Template
<!-- PublishableCodeSystem --><CodeSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishablecodesystem-definitions.html#CodeSystem.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) --> <identifier><!-- I 0..* Identifier Additional identifier for the code system (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the code system (Coding.version) --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this code system (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this code system (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the code system --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for code system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this code system is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the CodeSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the CodeSystem was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the CodeSystem is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- I 0..* ContactDetail Who edited the CodeSystem --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the CodeSystem --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the CodeSystem --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <caseSensitive value="[boolean]"/><!-- I 1..1 If code comparison is case sensitive --> <valueSet value="[canonical]"/><!-- I 0..1 Canonical reference to the value set with entire code system --> <hierarchyMeaning value="[code]"/><!-- I 0..1 grouped-by | is-a | part-of | classified-with --> <compositional value="[boolean]"/><!-- I 0..1 If code system defines a compositional grammar --> <versionNeeded value="[boolean]"/><!-- I 0..1 If definitions are not stable --> <content value="[code]"/><!-- I 1..1 not-present | example | fragment | complete | supplement --> <supplements value="[canonical]"/><!-- I 0..1 Canonical URL of Code System this adds designations and properties to --> <count value="[unsignedInt]"/><!-- I 0..1 Total concepts in the code system --> <filter> I 0..* BackboneElement <!-- I 0..* Filter that can be used in a value set --><<a href="publishablecodesystem-definitions.html#CodeSystem.filter.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code that identifies the filter --> <description value="[string]"/><!-- I 0..1 How or why the filter is used --> <operator value="[code]"/><!-- I 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists --> <value value="[string]"/><!-- I 1..1 What to use for the value --> </filter> <property> I 0..* BackboneElement <!-- I 0..* Additional information supplied about each concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Identifies the property on the concepts, and when referred to in operations --> <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property --> <description value="[string]"/><!-- I 0..1 Why the property is defined, and/or what it conveys --> <type value="[code]"/><!-- I 1..1 code | Coding | string | integer | boolean | dateTime | decimal --> </property> <concept> I 0..* BackboneElement <!-- I 0..* Concepts in the code system --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Code that identifies concept --> <display value="[string]"/><!-- I 0..1 Text to display to the user --> <definition value="[string]"/><!-- I 0..1 Formal definition --> <designation> I 0..* BackboneElement <!-- I 0..* Additional representations for the concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.designation.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <language value="[code]"/><!-- I 0..1 Human language of the designation --> <use><!-- I 0..1 Coding Details how this designation would be used --></use> <additionalUse><!-- I 0..* Coding Additional ways how this designation would be used --></additionalUse> <value value="[string]"/><!-- I 1..1 The text value for this designation --> </designation> <property> I 0..* BackboneElement <!-- I 0..* Property value for the concept --><<a href="publishablecodesystem-definitions.html#CodeSystem.concept.property.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code value="[code]"/><!-- I 1..1 Reference to CodeSystem.property.code --> <value[x]><!-- I 1..1 code|Coding|string|integer| boolean|dateTime|decimal Value of the property for this concept --></value[x]> </property> <concept><!-- See http://hl7.org/fhir/StructureDefinition/CodeSystem#CodeSystem.concept Child Concepts (is-a/contains/categorizes) --></concept> </concept> </CodeSystem>
JSON Template
{ // PublishableCodeSystem
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ //
{ // Where did this content come from // I
// from Element: extension
},
{ //
{ // Alternative names // I
// from Element: extension
}
],
"<a href="publishablecodesystem-definitions.html#CodeSystem.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
"identifier" : [{ Identifier }], // IAdditional identifier for the code system (business identifier)
"version" : "<string>", // I R! Business version of the code system (Coding.version)
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this code system (computer friendly)
"title" : "<string>", // I R! Name for this code system (human friendly)
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
"date" : "<dateTime>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the code system
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for code system (if applicable)
"purpose" : "<markdown>", // IWhy this code system is defined
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the CodeSystem was approved by publisher
"lastReviewDate" : "<date>", // IWhen the CodeSystem was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the CodeSystem is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the CodeSystem
"editor" : [{ ContactDetail }], // IWho edited the CodeSystem
"reviewer" : [{ ContactDetail }], // IWho reviewed the CodeSystem
"endorser" : [{ ContactDetail }], // IWho endorsed the CodeSystem
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"caseSensitive" : <boolean>, // I R! If code comparison is case sensitive
"valueSet" : "<canonical>", // ICanonical reference to the value set with entire code system
"hierarchyMeaning" : "<code>", // Igrouped-by | is-a | part-of | classified-with
"compositional" : <boolean>, // IIf code system defines a compositional grammar
"versionNeeded" : <boolean>, // IIf definitions are not stable
"content" : "<code>", // I R! not-present | example | fragment | complete | supplement
"supplements" : "<canonical>", // ICanonical URL of Code System this adds designations and properties to
"count" : "<unsignedInt>", // ITotal concepts in the code system
"filter" : [{ BackboneElement }], // IFilter that can be used in a value set
"property" : [{ BackboneElement }], // IAdditional information supplied about each concept
"concept" : [{ BackboneElement }], // IConcepts in the code system
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| CodeSystem.language | All Languages | required | All Languages |
| CodeSystem.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| CodeSystem.status | PublicationStatus | required | PublicationStatus |
| CodeSystem.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| CodeSystem.topic | Definition Topic | example | Definition Topic |
| CodeSystem.hierarchyMeaning | Code System Hierarchy Meaning | required | Code System Hierarchy Meaning |
| CodeSystem.content | Code System Content Mode | required | Code System Content Mode |
| CodeSystem.filter.operator | Filter Operator | required | Filter Operator |
| CodeSystem.property.type | Property Type | required | Property Type |
| CodeSystem.concept.designation.language | All Languages | required | All Languages |
| CodeSystem.concept.designation.use | Designation Use | extensible | Designation Use |
| CodeSystem.concept.designation.additionalUse | Designation Use | extensible | Designation Use |