Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: ShareableCodeSystem

Vocabulary icon Work Group Maturity Level: 0Trial 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

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

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C icon1..1CodeSystemDeclares 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
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version S1..1stringBusiness version of the code system (Coding.version)
... title S1..1stringName for this code system (human friendly)
... status S1..1codedraft | active | retired | unknown
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher/steward (organization or individual)
... description S1..1markdownNatural language description of the code system
... caseSensitive S1..1booleanIf code comparison is case sensitive
... hierarchyMeaning SC icon0..1codegrouped-by | is-a | part-of | classified-with
... content SC icon1..1codenot-present | example | fragment | complete | supplement
... concept SC icon0..*BackboneElementConcepts in the code system
.... code S1..1codeCode that identifies concept
.... display S0..1stringText to display to the user
.... definition S0..1stringFormal definition
.... concept SC icon0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C icon1..1CodeSystemDeclares 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
... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..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 SΣ1..1stringBusiness version of the code system (Coding.version)
... name SΣC icon0..1stringName for this code system (computer friendly)
... title SΣ1..1stringName for this code system (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..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
... approvalDate 0..1dateWhen the CodeSystem was approved by publisher
... lastReviewDate 0..1dateWhen the CodeSystem was last reviewed
... effectivePeriod Σ0..1PeriodWhen the CodeSystem is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author 0..*ContactDetailWho authored the CodeSystem
... editor 0..*ContactDetailWho edited the CodeSystem
... reviewer 0..*ContactDetailWho reviewed the CodeSystem
... endorser 0..*ContactDetailWho endorsed the CodeSystem
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... caseSensitive SΣ1..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning SΣC icon0..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 SΣC icon1..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 | child-of | descendent-leaf | 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 SC icon0..*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 S1..1codeCode that identifies concept
.... display S0..1stringText to display to the user
.... definition S0..1stringFormal definition
.... designation C icon0..*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.

..... additionalUse 0..*CodingAdditional ways 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 SC icon0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format
<!-- 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) -->
 <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 -->
 <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 -->
 <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)
    "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
    "approvalDate" : "<date>", // IWhen the CodeSystem was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the CodeSystem was last reviewed
    "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: 17 elements

Extensions

This structure refers to these extensions:

Differential View

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C icon1..1CodeSystemDeclares 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
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... version S1..1stringBusiness version of the code system (Coding.version)
... title S1..1stringName for this code system (human friendly)
... status S1..1codedraft | active | retired | unknown
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher/steward (organization or individual)
... description S1..1markdownNatural language description of the code system
... caseSensitive S1..1booleanIf code comparison is case sensitive
... hierarchyMeaning SC icon0..1codegrouped-by | is-a | part-of | classified-with
... content SC icon1..1codenot-present | example | fragment | complete | supplement
... concept SC icon0..*BackboneElementConcepts in the code system
.... code S1..1codeCode that identifies concept
.... display S0..1stringText to display to the user
.... definition S0..1stringFormal definition
.... concept SC icon0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Snapshot View

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem C icon1..1CodeSystemDeclares 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
... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..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 SΣ1..1stringBusiness version of the code system (Coding.version)
... name SΣC icon0..1stringName for this code system (computer friendly)
... title SΣ1..1stringName for this code system (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..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
... approvalDate 0..1dateWhen the CodeSystem was approved by publisher
... lastReviewDate 0..1dateWhen the CodeSystem was last reviewed
... effectivePeriod Σ0..1PeriodWhen the CodeSystem is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author 0..*ContactDetailWho authored the CodeSystem
... editor 0..*ContactDetailWho edited the CodeSystem
... reviewer 0..*ContactDetailWho reviewed the CodeSystem
... endorser 0..*ContactDetailWho endorsed the CodeSystem
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... caseSensitive SΣ1..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning SΣC icon0..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 SΣC icon1..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 | child-of | descendent-leaf | 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 SC icon0..*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 S1..1codeCode that identifies concept
.... display S0..1stringText to display to the user
.... definition S0..1stringFormal definition
.... designation C icon0..*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.

..... additionalUse 0..*CodingAdditional ways 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 SC icon0..*See concept (CodeSystem)Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

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) -->
 <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 -->
 <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 -->
 <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)
    "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
    "approvalDate" : "<date>", // IWhen the CodeSystem was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the CodeSystem was last reviewed
    "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.24.3.2 Terminology Bindings

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

4.8.24.3.3 Constraints

RuleRule
IdPathDetailsRequirements
scs-1CodeSystemIf a codesystem contains nested concepts, it must specify hierarchyMeaning
Expression icon: concept.concept.exists() implies hierarchyMeaning.exists()
scs-2CodeSystemIf 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()
.