Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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

4.8.24.3 StructureDefinition: Shareable CodeSystem

Vocabulary Work Group Maturity Level: 0Trial Use Use Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/shareablecodesystem

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

4.8.24.3.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from CodeSystem.

Summary

Mandatory: 9 elements

This structure is derived from CodeSystem.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1CodeSystemDeclares the existence of and describes a code system or code system supplement
... url 1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version 1..1stringBusiness version of the code system (Coding.version)
... name 1..1stringName for this code system (computer friendly)
... experimental 1..1booleanFor testing purposes, not real usage
... publisher 1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the code system
... caseSensitive 0..1booleanIf code comparison is case sensitive
... concept 1..*BackboneElementConcepts in the code system
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I1..1CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ0..*IdentifierAdditional identifier for the code system (business identifier)
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name Σ1..1stringName for this code system (computer friendly)
... title Σ0..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the code system
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ1..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
..... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format
<!-- Shareable CodeSystem -->doco

<CodeSystem xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- ?? 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 
     Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the code system (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the code system (Coding.version) -->
 <name value="[string]"/><!-- ?? 1..1 Name for this code system (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this code system (human friendly) -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the code system -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for code system (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this code system is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <caseSensitive value="[boolean]"/><!-- ?? 0..1 If code comparison is case sensitive -->
 <valueSet value="[canonical]"/><!-- ?? 0..1 Canonical reference to the value set with entire code system -->
 <hierarchyMeaning value="[code]"/><!-- ?? 0..1 grouped-by | is-a | part-of | classified-with   -->
 <compositional value="[boolean]"/><!-- ?? 0..1 If code system defines a compositional grammar -->
 <versionNeeded value="[boolean]"/><!-- ?? 0..1 If definitions are not stable -->
 <content value="[code]"/><!-- ?? 1..1 not-present | example | fragment | complete | supplement   -->
 <supplements value="[canonical]"/><!-- ?? 0..1 Canonical URL of Code System this adds designations and properties to -->
 <count value="[unsignedInt]"/><!-- ?? 0..1 Total concepts in the code system -->
 <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Filter that can be used in a value set -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 Code that identifies the filter -->
  <description value="[string]"/><!-- ?? 0..1 How or why the filter is used -->
  <operator value="[code]"/><!-- ?? 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists   -->
  <value value="[string]"/><!-- ?? 1..1 What to use for the value -->
 </filter>
 <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 
      Identifies the property on the concepts, and when referred to in operations -->
  <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  <description value="[string]"/><!-- ?? 0..1 Why the property is defined, and/or what it conveys -->
  <type value="[code]"/><!-- ?? 1..1 code | Coding | string | integer | boolean | dateTime | decimal   -->
 </property>
 <concept> ?? 1..* BackboneElement  <!-- ?? 1..* Concepts in the code system -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 Code that identifies concept -->
  <display value="[string]"/><!-- ?? 0..1 Text to display to the user -->
  <definition value="[string]"/><!-- ?? 0..1 Formal definition -->
  <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for the concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
   <use><!-- ?? 0..1 Coding Details how this designation would be used   --></use>
   <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
  </designation>
  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Property value for the concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 Reference to CodeSystem.property.code -->
   <value[x]><!-- ?? 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>

{ // Shareable CodeSystem
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], // C?Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
    "identifier" : [{ Identifier }], // C?Additional identifier for the code system (business identifier)
    "version" : "<string>", // C? R! Business version of the code system (Coding.version)
    "name" : "<string>", // C? R! Name for this code system (computer friendly)
    "title" : "<string>", // C?Name for this code system (human friendly)
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the code system
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for code system (if applicable)
    "purpose" : "<markdown>", // C?Why this code system is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "caseSensitive" : <boolean>, // C?If code comparison is case sensitive
    "valueSet" : "<canonical>", // C?Canonical reference to the value set with entire code system
    "hierarchyMeaning" : "<code>", // C?grouped-by | is-a | part-of | classified-with
    "compositional" : <boolean>, // C?If code system defines a compositional grammar
    "versionNeeded" : <boolean>, // C?If definitions are not stable
    "content" : "<code>", // C? R! not-present | example | fragment | complete | supplement
    "supplements" : "<canonical>", // C?Canonical URL of Code System this adds designations and properties to
    "count" : "<unsignedInt>", // C?Total concepts in the code system
    "filter" : [{ BackboneElement }], // C?Filter that can be used in a value set
    "property" : [{ BackboneElement }], // C?Additional information supplied about each concept
    "concept" : [{ BackboneElement }] // C? R! Concepts in the code system
  }

This structure is derived from CodeSystem.

Summary

Mandatory: 9 elements

Differential View

This structure is derived from CodeSystem.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem 1..1CodeSystemDeclares the existence of and describes a code system or code system supplement
... url 1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version 1..1stringBusiness version of the code system (Coding.version)
... name 1..1stringName for this code system (computer friendly)
... experimental 1..1booleanFor testing purposes, not real usage
... publisher 1..1stringName of the publisher (organization or individual)
... description 1..1markdownNatural language description of the code system
... caseSensitive 0..1booleanIf code comparison is case sensitive
... concept 1..*BackboneElementConcepts in the code system
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I1..1CodeSystemDeclares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier Σ0..*IdentifierAdditional identifier for the code system (business identifier)
... version Σ1..1stringBusiness version of the code system (Coding.version)
... name Σ1..1stringName for this code system (computer friendly)
... title Σ0..1stringName for this code system (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the code system
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this code system is defined
... copyright 0..1markdownUse and/or publishing restrictions
... caseSensitive Σ0..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.

... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter Σ0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.


.... value Σ1..1stringWhat to use for the value
... property Σ0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.

... concept 1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation 0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
..... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

..... value 1..1stringThe text value for this designation
.... property 0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

XML Template

<!-- Shareable CodeSystem -->doco

<CodeSystem xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- ?? 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 
     Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the code system (business identifier) --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the code system (Coding.version) -->
 <name value="[string]"/><!-- ?? 1..1 Name for this code system (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this code system (human friendly) -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the code system -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for code system (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this code system is defined -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <caseSensitive value="[boolean]"/><!-- ?? 0..1 If code comparison is case sensitive -->
 <valueSet value="[canonical]"/><!-- ?? 0..1 Canonical reference to the value set with entire code system -->
 <hierarchyMeaning value="[code]"/><!-- ?? 0..1 grouped-by | is-a | part-of | classified-with   -->
 <compositional value="[boolean]"/><!-- ?? 0..1 If code system defines a compositional grammar -->
 <versionNeeded value="[boolean]"/><!-- ?? 0..1 If definitions are not stable -->
 <content value="[code]"/><!-- ?? 1..1 not-present | example | fragment | complete | supplement   -->
 <supplements value="[canonical]"/><!-- ?? 0..1 Canonical URL of Code System this adds designations and properties to -->
 <count value="[unsignedInt]"/><!-- ?? 0..1 Total concepts in the code system -->
 <filter> ?? 0..* BackboneElement  <!-- ?? 0..* Filter that can be used in a value set -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 Code that identifies the filter -->
  <description value="[string]"/><!-- ?? 0..1 How or why the filter is used -->
  <operator value="[code]"/><!-- ?? 1..* = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists   -->
  <value value="[string]"/><!-- ?? 1..1 What to use for the value -->
 </filter>
 <property> ?? 0..* BackboneElement  <!-- ?? 0..* Additional information supplied about each concept -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 
      Identifies the property on the concepts, and when referred to in operations -->
  <uri value="[uri]"/><!-- ?? 0..1 Formal identifier for the property -->
  <description value="[string]"/><!-- ?? 0..1 Why the property is defined, and/or what it conveys -->
  <type value="[code]"/><!-- ?? 1..1 code | Coding | string | integer | boolean | dateTime | decimal   -->
 </property>
 <concept> ?? 1..* BackboneElement  <!-- ?? 1..* Concepts in the code system -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- ?? 1..1 Code that identifies concept -->
  <display value="[string]"/><!-- ?? 0..1 Text to display to the user -->
  <definition value="[string]"/><!-- ?? 0..1 Formal definition -->
  <designation> ?? 0..* BackboneElement  <!-- ?? 0..* Additional representations for the concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <language value="[code]"/><!-- ?? 0..1 Human language of the designation   -->
   <use><!-- ?? 0..1 Coding Details how this designation would be used   --></use>
   <value value="[string]"/><!-- ?? 1..1 The text value for this designation -->
  </designation>
  <property> ?? 0..* BackboneElement  <!-- ?? 0..* Property value for the concept -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- ?? 1..1 Reference to CodeSystem.property.code -->
   <value[x]><!-- ?? 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

{ // Shareable CodeSystem
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], // C?Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
    "identifier" : [{ Identifier }], // C?Additional identifier for the code system (business identifier)
    "version" : "<string>", // C? R! Business version of the code system (Coding.version)
    "name" : "<string>", // C? R! Name for this code system (computer friendly)
    "title" : "<string>", // C?Name for this code system (human friendly)
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the code system
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for code system (if applicable)
    "purpose" : "<markdown>", // C?Why this code system is defined
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "caseSensitive" : <boolean>, // C?If code comparison is case sensitive
    "valueSet" : "<canonical>", // C?Canonical reference to the value set with entire code system
    "hierarchyMeaning" : "<code>", // C?grouped-by | is-a | part-of | classified-with
    "compositional" : <boolean>, // C?If code system defines a compositional grammar
    "versionNeeded" : <boolean>, // C?If definitions are not stable
    "content" : "<code>", // C? R! not-present | example | fragment | complete | supplement
    "supplements" : "<canonical>", // C?Canonical URL of Code System this adds designations and properties to
    "count" : "<unsignedInt>", // C?Total concepts in the code system
    "filter" : [{ BackboneElement }], // C?Filter that can be used in a value set
    "property" : [{ BackboneElement }], // C?Additional information supplied about each concept
    "concept" : [{ BackboneElement }] // C? R! Concepts in the code system
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

4.8.24.3.2 Terminology Bindings

PathNameConformanceValueSet
CodeSystem.languageCommon LanguagespreferredCommon Languages
CodeSystem.statusPublicationStatusrequiredPublicationStatus
CodeSystem.jurisdictionJurisdictionextensibleJurisdiction
CodeSystem.hierarchyMeaningCodeSystemHierarchyMeaningrequiredCodeSystemHierarchyMeaning
CodeSystem.contentCodeSystemContentModerequiredCodeSystemContentMode
CodeSystem.filter.operatorFilterOperatorrequiredFilterOperator
CodeSystem.property.typePropertyTyperequiredPropertyType
CodeSystem.concept.designation.languageCommon LanguagespreferredCommon Languages
CodeSystem.concept.designation.useDesignation UseextensibleDesignation Use
.