http://hl7.org/fhir/StructureDefinition/CodeSystem|5.0.0

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.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
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.
derivation: specialization
name: CodeSystem
type: CodeSystem
elements:
  description: {isModifier: false, short: Natural language description of the code system, mustSupport: false, isSummary: false, index: 12}
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 9}
  versionNeeded: {isModifier: false, short: If definitions are not stable, mustSupport: false, isSummary: true, index: 31}
  endorser: {isModifier: false, short: Who endorsed the CodeSystem, mustSupport: false, array: true, isSummary: false, index: 25}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 10}
  approvalDate: {isModifier: false, short: When the CodeSystem was approved by publisher, mustSupport: false, isSummary: false, index: 18}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for code system (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 14
  purpose: {isModifier: false, short: Why this code system is defined, mustSupport: false, isSummary: false, index: 15}
  content:
    isModifier: false
    short: not-present | example | fragment | complete | supplement
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/codesystem-content-mode|5.0.0'}
    isSummary: true
    index: 32
  property:
    isModifier: false
    short: Additional information supplied about each concept
    mustSupport: false
    array: true
    isSummary: true
    index: 40
    elements:
      code: {isModifier: false, short: 'Identifies the property on the concepts, and when referred to in operations', mustSupport: false, isSummary: true, index: 41}
      uri: {isModifier: false, short: Formal identifier for the property, mustSupport: false, isSummary: true, index: 42}
      description: {isModifier: false, short: 'Why the property is defined, and/or what it conveys', mustSupport: false, isSummary: true, index: 43}
      type:
        isModifier: false
        short: code | Coding | string | integer | boolean | dateTime | decimal
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/concept-property-type|5.0.0'}
        isSummary: true
        index: 44
    required: [type, code]
  name: {isModifier: false, short: Name for this code system (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 17}
  useContext: {isModifier: false, short: The context that the content is intended to support, mustSupport: false, array: true, isSummary: true, index: 13}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 16}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 8}
  topic:
    isModifier: false
    short: E.g. Education, Treatment, Assessment, etc
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    isSummary: false
    index: 21
  title: {isModifier: false, short: Name for this code system (human friendly), mustSupport: false, isSummary: true, index: 6}
  author: {isModifier: false, short: Who authored the CodeSystem, mustSupport: false, array: true, isSummary: false, index: 22}
  filter:
    isModifier: false
    short: Filter that can be used in a value set
    mustSupport: false
    array: true
    isSummary: true
    index: 35
    elements:
      code: {isModifier: false, short: Code that identifies the filter, mustSupport: false, isSummary: true, index: 36}
      description: {isModifier: false, short: How or why the filter is used, mustSupport: false, isSummary: true, index: 37}
      operator:
        min: 1
        isModifier: false
        short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
        index: 38
        mustSupport: false
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/filter-operator|5.0.0'}
        isSummary: true
      value: {isModifier: false, short: What to use for the value, mustSupport: false, isSummary: true, index: 39}
    required: [operator, value, code]
  supplements: {isModifier: false, short: Canonical URL of Code System this adds designations and properties to, mustSupport: false, isSummary: true, index: 33}
  compositional: {isModifier: false, short: If code system defines a compositional grammar, mustSupport: false, isSummary: true, index: 30}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired CodeSystem without due consideration
    isSummary: true
    index: 7
  hierarchyMeaning:
    isModifier: false
    short: grouped-by | is-a | part-of | classified-with
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|5.0.0'}
    isSummary: true
    index: 29
  valueSet: {isModifier: false, short: Canonical reference to the value set with entire code system, mustSupport: false, isSummary: true, index: 28}
  count: {isModifier: false, short: Total concepts in the code system, mustSupport: false, isSummary: true, index: 34}
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/CodeSystem', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the code system (business identifier), mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the CodeSystem was last reviewed by the publisher, mustSupport: false, isSummary: false, index: 19}
  editor: {isModifier: false, short: Who edited the CodeSystem, mustSupport: false, array: true, isSummary: false, index: 23}
  concept:
    isModifier: false
    short: Concepts in the code system
    mustSupport: false
    array: true
    isSummary: false
    index: 45
    elements:
      code: {isModifier: false, short: Code that identifies concept, mustSupport: false, isSummary: false, index: 46}
      display: {isModifier: false, short: Text to display to the user, mustSupport: false, isSummary: false, index: 47}
      definition: {isModifier: false, short: Formal definition, mustSupport: false, isSummary: false, index: 48}
      designation:
        constraint:
          csd-5: {human: Must have a value for concept.designation.use if concept.designation.additionalUse is present, source: 'http://hl7.org/fhir/StructureDefinition/CodeSystem', severity: error, expression: additionalUse.exists() implies use.exists()}
        isModifier: false
        short: Additional representations for the concept
        index: 49
        mustSupport: false
        array: true
        elements:
          language:
            isModifier: false
            short: Human language of the designation
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages|5.0.0'}
            isSummary: false
            index: 50
          use:
            isModifier: false
            short: Details how this designation would be used
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
            isSummary: false
            index: 51
          additionalUse:
            isModifier: false
            short: Additional ways how this designation would be used
            mustSupport: false
            array: true
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/designation-use'}
            isSummary: false
            index: 52
          value: {isModifier: false, short: The text value for this designation, mustSupport: false, isSummary: false, index: 53}
        required: [value]
        isSummary: false
      property:
        isModifier: false
        short: Property value for the concept
        mustSupport: false
        array: true
        isSummary: false
        index: 54
        elements:
          code: {isModifier: false, short: Reference to CodeSystem.property.code, mustSupport: false, isSummary: false, index: 55}
          value:
            isModifier: false
            short: Value of the property for this concept
            mustSupport: false
            choices: []
            isSummary: false
            index: 57
        required: [value, code]
      concept:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CodeSystem', elements, concept]
        isModifier: false
        short: Child Concepts (is-a/contains/categorizes)
        mustSupport: false
        array: true
        isSummary: false
        index: 58
    required: [code]
  caseSensitive: {isModifier: false, short: If code comparison is case sensitive, mustSupport: false, isSummary: true, index: 27}
  reviewer: {isModifier: false, short: Who reviewed the CodeSystem, mustSupport: false, array: true, isSummary: false, index: 24}
  version: {isModifier: false, short: Business version of the code system (Coding.version), mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc', mustSupport: false, array: true, isSummary: false, index: 26}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 11}
  effectivePeriod: {isModifier: false, short: When the CodeSystem is expected to be used, mustSupport: false, isSummary: true, index: 20}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CodeSystem
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status, content]