FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.8.22.2 StructureDefinition: ShareableCodeSystem

Terminology Infrastructure icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

The canonical URL for this profile is: 

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

Enforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems

Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management icon 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+0000 as a draft by HL7.

4.8.22.2.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: 6 elements (+1 nested mandatory element)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base CodeSystem structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. CodeSystem C icon 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
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
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version S 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
... name S 0..1 string Name for this code system (computer friendly)
... title S 1..1 string Name for this code system (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the code system
... caseSensitive S 1..1 boolean If code comparison is case sensitive
... hierarchyMeaning SC icon 0..1 code grouped-by | is-a | part-of | classified-with
... content SC icon 1..1 code not-present | example | fragment | complete | supplement
... concept SC icon 0..* BackboneElement Concepts in the code system
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... concept SC icon 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base CodeSystem structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. CodeSystem C icon 1..1 CodeSystem 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC icon 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
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC icon 0..1 string Name for this code system (computer friendly)
... title SΣ 1..1 string Name for this code system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the CodeSystem was approved by publisher
... lastReviewDate 0..1 date When the CodeSystem was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the CodeSystem is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning SΣC icon 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.

... compositional Σ 0..1 boolean If code system defines a compositional grammar
... versionNeeded Σ 0..1 boolean If definitions are not stable
... content SΣC icon 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.

... supplements ΣC icon 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 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.


.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: Property Type (required): The type of a property value.

... concept SC icon 0..* BackboneElement Concepts in the code system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SC icon 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... designation C icon 0..* BackboneElement Additional representations for the concept
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
..... use C icon 0..1 Coding Details how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

..... additionalUse C icon 0..* Coding Additional ways how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.


..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C icon 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept SC icon 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format icon
<!-- ShareableCodeSystem -->doco

<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>
 <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 0..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 -->
  <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 -->
  <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 -->
  <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 -->
   <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 -->
   <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>

{ // ShareableCodeSystem
  // 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
      }
    ],
    "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>", // IDate 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 CodeSystem.

Summary

Mandatory: 6 elements (+1 nested mandatory element)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base CodeSystem structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. CodeSystem C icon 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
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
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S 1..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version S 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
... name S 0..1 string Name for this code system (computer friendly)
... title S 1..1 string Name for this code system (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the code system
... caseSensitive S 1..1 boolean If code comparison is case sensitive
... hierarchyMeaning SC icon 0..1 code grouped-by | is-a | part-of | classified-with
... content SC icon 1..1 code not-present | example | fragment | complete | supplement
... concept SC icon 0..* BackboneElement Concepts in the code system
.... code S 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... concept SC icon 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base CodeSystem structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. CodeSystem C icon 1..1 CodeSystem 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC icon 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
... identifier Σ 0..* Identifier Additional identifier for the code system (business identifier)
... version SΣ 1..1 string Business version of the code system (Coding.version)
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC icon 0..1 string Name for this code system (computer friendly)
... title SΣ 1..1 string Name for this code system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the code system
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this code system is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the CodeSystem was approved by publisher
... lastReviewDate 0..1 date When the CodeSystem was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the CodeSystem is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the CodeSystem
... reviewer 0..* ContactDetail Who reviewed the CodeSystem
... endorser 0..* ContactDetail Who endorsed the CodeSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... caseSensitive SΣ 1..1 boolean If code comparison is case sensitive
... valueSet Σ 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
... hierarchyMeaning SΣC icon 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.

... compositional Σ 0..1 boolean If code system defines a compositional grammar
... versionNeeded Σ 0..1 boolean If definitions are not stable
... content SΣC icon 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.

... supplements ΣC icon 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
... count Σ 0..1 unsignedInt Total concepts in the code system
... filter Σ 0..* BackboneElement Filter that can be used in a value set
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Code that identifies the filter
.... description Σ 0..1 string How or why the filter is used
.... operator Σ 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.


.... value Σ 1..1 string What to use for the value
... property Σ 0..* BackboneElement Additional information supplied about each concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type Σ 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: Property Type (required): The type of a property value.

... concept SC icon 0..* BackboneElement Concepts in the code system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code SC icon 1..1 code Code that identifies concept
.... display S 0..1 string Text to display to the user
.... definition S 0..1 string Formal definition
.... designation C icon 0..* BackboneElement Additional representations for the concept
csd-5: Must have a value for concept.designation.use if concept.designation.additionalUse is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... language 0..1 code Human language of the designation
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
..... use C icon 0..1 Coding Details how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.

..... additionalUse C icon 0..* Coding Additional ways how this designation would be used
Binding: Designation Use (extensible): Details of how a designation would be used.


..... value 1..1 string The text value for this designation
.... property 0..* BackboneElement Property value for the concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C icon 1..1 code Reference to CodeSystem.property.code
..... value[x] 1..1 Value of the property for this concept
...... valueCode code
...... valueCoding Coding
...... valueString string
...... valueInteger integer
...... valueBoolean boolean
...... valueDateTime dateTime
...... valueDecimal decimal
.... concept SC icon 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format icon

XML Template

<!-- ShareableCodeSystem -->doco

<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>
 <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 0..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 -->
  <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 -->
  <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 -->
  <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 -->
   <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 -->
   <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

{ // ShareableCodeSystem
  // 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
      }
    ],
    "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>", // IDate 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

4.8.22.2.2 Terminology Bindings

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

4.8.22.2.3 Constraints

RuleRule
Id Path Details Requirements
scs-1 CodeSystem If a codesystem contains nested concepts, it must specify hierarchyMeaning
Expression icon: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2 CodeSystem If a codesystem contains example, fragment, or complete content, it must have at least one concept
Expression icon: content in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()
. .