description: The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
package_name: hl7.fhir.r4.core
derivation: specialization
name: CodeSystem
type: CodeSystem
elements:
  description: {short: Natural language description of the code system, type: markdown, index: 10}
  date: {short: Date last changed, type: dateTime, isSummary: true, index: 7}
  versionNeeded: {short: If definitions are not stable, type: boolean, isSummary: true, index: 19}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 8}
  jurisdiction:
    short: Intended jurisdiction for code system (if applicable)
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 12
  purpose: {short: Why this code system is defined, type: markdown, index: 13}
  content:
    short: not-present | example | fragment | complete | supplement
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1'}
    isSummary: true
    index: 20
  property:
    short: Additional information supplied about each concept
    type: BackboneElement
    array: true
    isSummary: true
    index: 28
    elements:
      code: {type: code, short: 'Identifies the property on the concepts, and when referred to in operations', isSummary: true, index: 29}
      uri: {type: uri, short: Formal identifier for the property, isSummary: true, index: 30}
      description: {type: string, short: 'Why the property is defined, and/or what it conveys', isSummary: true, index: 31}
      type:
        short: code | Coding | string | integer | boolean | dateTime | decimal
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1'}
        isSummary: true
        index: 32
    required: [type, code]
  name: {short: Name for this code system (computer friendly), type: string, isSummary: true, index: 3}
  useContext: {short: The context that the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 11}
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 14}
  experimental: {short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 6}
  title: {short: Name for this code system (human friendly), type: string, isSummary: true, index: 4}
  filter:
    short: Filter that can be used in a value set
    type: BackboneElement
    array: true
    isSummary: true
    index: 23
    elements:
      code: {type: code, short: Code that identifies the filter, isSummary: true, index: 24}
      description: {type: string, short: How or why the filter is used, isSummary: true, index: 25}
      operator:
        min: 1
        short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
        type: code
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/filter-operator|4.0.1'}
        isSummary: true
        index: 26
      value: {type: string, short: What to use for the value, isSummary: true, index: 27}
    required: [operator, value, code]
  supplements: {short: Canonical URL of Code System this adds designations and properties to, type: canonical, isSummary: true, index: 21}
  compositional: {short: If code system defines a compositional grammar, type: boolean, isSummary: true, index: 18}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.0.1'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 5
  hierarchyMeaning:
    short: grouped-by | is-a | part-of | classified-with
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1'}
    isSummary: true
    index: 17
  valueSet: {short: Canonical reference to the value set with entire code system, type: canonical, isSummary: true, index: 16}
  count: {short: Total concepts in the code system, type: unsignedInt, isSummary: true, index: 22}
  url: {short: 'Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)', type: uri, isSummary: true, index: 0}
  identifier: {short: Additional identifier for the code system (business identifier), type: Identifier, array: true, isSummary: true, index: 1}
  concept:
    short: Concepts in the code system
    type: BackboneElement
    array: true
    index: 33
    elements:
      code: {type: code, short: Code that identifies concept, index: 34}
      display: {type: string, short: Text to display to the user, index: 35}
      definition: {type: string, short: Formal definition, index: 36}
      designation:
        short: Additional representations for the concept
        type: BackboneElement
        array: true
        index: 37
        elements:
          language:
            short: Human language of the designation
            type: code
            binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/languages'}
            index: 38
          use:
            short: Details how this designation would be used
            type: Coding
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
            index: 39
          value: {type: string, short: The text value for this designation, index: 40}
        required: [value]
      property:
        type: BackboneElement
        short: Property value for the concept
        array: true
        index: 41
        elements:
          valueCode: {type: code, short: Value of the property for this concept, choiceOf: value, index: 45}
          valueDecimal: {type: decimal, short: Value of the property for this concept, choiceOf: value, index: 51}
          value:
            short: Value of the property for this concept
            choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime, valueDecimal]
            index: 44
          valueString: {type: string, short: Value of the property for this concept, choiceOf: value, index: 47}
          valueBoolean: {type: boolean, short: Value of the property for this concept, choiceOf: value, index: 49}
          valueDateTime: {type: dateTime, short: Value of the property for this concept, choiceOf: value, index: 50}
          valueCoding: {type: Coding, short: Value of the property for this concept, choiceOf: value, index: 46}
          code: {type: code, short: Reference to CodeSystem.property.code, index: 42}
          valueInteger: {type: integer, short: Value of the property for this concept, choiceOf: value, index: 48}
        required: [valueCoding, valueString, valueCode, valueDecimal, valueDateTime, value, valueBoolean, code, valueInteger]
      concept:
        short: Child Concepts (is-a/contains/categorizes)
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CodeSystem', elements, concept]
        array: true
        index: 52
    required: [code]
  caseSensitive: {short: If code comparison is case sensitive, type: boolean, isSummary: true, index: 15}
  version: {short: Business version of the code system (Coding.version), type: string, isSummary: true, index: 2}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 9}
package_version: 4.0.1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CodeSystem
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [status, content]