description: Base StructureDefinition for CodeSystem Resource
package_name: hl7.fhir.r2b.core
derivation: specialization
name: CodeSystem
type: null
elements:
  description:
    isModifier: false
    short: Human language description of the code system
    index: 11
    comments: The description is not intended to describe the semantics of the Code System - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a description.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.description}
    isSummary: true
  requirements:
    isModifier: false
    short: Why needed
    index: 13
    comments: This element does not describe the usage of the code system (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do.  This may be used to point to source materials or specifications that drove the structure of this data element.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.requirements}
    isSummary: false
  date:
    isModifier: false
    short: Date for given status
    index: 10
    comments: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions.
    type: dateTime
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.date}
    isSummary: true
  versionNeeded:
    isModifier: false
    short: If definitions are not stable
    index: 18
    comments: Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.versionNeeded}
    isSummary: true
  publisher:
    isModifier: false
    short: Name of the publisher (organization or individual)
    index: 6
    comments: Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.publisher}
    isSummary: true
  content:
    isModifier: false
    short: not-present | examplar | fragment | complete
    index: 19
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.content}
    isSummary: true
  property:
    isModifier: false
    short: Additional information supplied about each concept
    index: 26
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: Identifies the property, both internally and externally
        index: 27
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.property.code}
        isSummary: true
      description:
        isModifier: false
        short: Why the property is defined, and/or what it conveys
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.property.description}
        isSummary: true
        index: 28
      type:
        isModifier: false
        short: code | Coding | string | integer | boolean | dateTime
        index: 29
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.property.type}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: CodeSystem.property}
    required: [type, code]
    isSummary: true
  name:
    isModifier: false
    short: Informal name for this code system
    index: 3
    comments: The name is not expected to be unique. A name should be provided unless the code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a name.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.name}
    isSummary: true
  useContext:
    isModifier: false
    short: Content intends to support these contexts
    index: 12
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: CodeSystem.useContext}
    isSummary: true
  copyright:
    isModifier: false
    short: Use and/or publishing restrictions
    index: 14
    comments: Frequently, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.copyright}
    isSummary: false
  experimental:
    isModifier: false
    short: If for testing purposes, not real usage
    index: 5
    comments: Allows filtering of code systems that are appropriate for use vs. not.
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.experimental}
    isSummary: true
  filter:
    isModifier: false
    short: Filter that can be used in a value set
    index: 21
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: Code that identifies the filter
        index: 22
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.filter.code}
        isSummary: true
      description:
        isModifier: false
        short: How or why the filter is used
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.filter.description}
        isSummary: true
        index: 23
      operator:
        min: 1
        isModifier: false
        short: Operators that can be used with filter
        index: 24
        type: code
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: CodeSystem.filter.operator}
        isSummary: true
      value:
        isModifier: false
        short: What to use for the value
        index: 25
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.filter.value}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: CodeSystem.filter}
    required: [operator, value, code]
    isSummary: true
  compositional:
    isModifier: false
    short: If code system defines a post-composition grammar
    index: 17
    comments: Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.compositional}
    isSummary: true
  status:
    isModifier: true
    short: draft | active | retired
    index: 4
    comments: Allows filtering of code system instances that are appropriate (or not) for use.
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.status}
    isSummary: true
  valueSet:
    isModifier: false
    short: Canonical URL for value set with entire code system
    type: uri
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.valueSet}
    isSummary: true
    index: 16
  count:
    isModifier: false
    short: Total concepts in the code system
    index: 20
    comments: The count of concepts defined in this resource cannot be more than this value, but may be less for several reasons - see the content value.
    type: unsignedInt
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.count}
    isSummary: true
  url:
    isModifier: false
    short: Globally unique logical identifier for  code system (Coding.system)
    type: uri
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.url}
    isSummary: true
    index: 0
  identifier:
    isModifier: false
    short: Additional identifier for the code system (e.g. HL7 v2 / CDA)
    index: 1
    comments: Typically, this is used for values that can go in an HL7 v3 II data type.
    type: Identifier
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.identifier}
    isSummary: true
  concept:
    isModifier: false
    short: Concepts in the code system
    index: 30
    comments: If this is empty, it means that the code system resource does not represent the content of the code system.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: Code that identifies concept
        index: 31
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.concept.code}
        isSummary: false
      display:
        isModifier: false
        short: Text to display to the user
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.concept.display}
        isSummary: false
        index: 32
      definition:
        isModifier: false
        short: Formal definition
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.concept.definition}
        isSummary: false
        index: 33
      designation:
        isModifier: false
        short: Additional representations for the concept
        index: 34
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          language:
            isModifier: false
            short: Human language of the designation
            index: 35
            comments: In the absence of a language, the resource language applies.
            type: code
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: CodeSystem.concept.designation.language}
            isSummary: false
          use:
            isModifier: false
            short: Details how this designation would be used
            index: 36
            comments: If no use is provided, the designation can be assumed to be suitable for general display to a human user.
            type: Coding
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: CodeSystem.concept.designation.use}
            isSummary: false
          value:
            isModifier: false
            short: The text value for this designation
            index: 37
            type: string
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: CodeSystem.concept.designation.value}
            isSummary: false
        maxLength: 0
        base: {max: '*', min: 0, path: CodeSystem.concept.designation}
        required: [value]
        isSummary: false
      property:
        isModifier: false
        short: Property value for the concept
        index: 38
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          code:
            isModifier: false
            short: Reference to CodeSystem.property.code
            index: 39
            type: code
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: CodeSystem.concept.property.code}
            isSummary: false
          value:
            isModifier: false
            short: Value of the property for this concept
            index: 41
            mustSupport: false
            choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime]
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            isSummary: false
          valueCode:
            isModifier: false
            short: Value of the property for this concept
            index: 42
            type: code
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
          valueCoding:
            isModifier: false
            short: Value of the property for this concept
            index: 43
            type: Coding
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
          valueString:
            isModifier: false
            short: Value of the property for this concept
            index: 44
            type: string
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
          valueInteger:
            isModifier: false
            short: Value of the property for this concept
            index: 45
            type: integer
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
          valueBoolean:
            isModifier: false
            short: Value of the property for this concept
            index: 46
            type: boolean
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
          valueDateTime:
            isModifier: false
            short: Value of the property for this concept
            index: 47
            type: dateTime
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'CodeSystem.concept.property.value[x]'}
            choiceOf: value
            isSummary: false
        maxLength: 0
        base: {max: '*', min: 0, path: CodeSystem.concept.property}
        required: [valueCoding, valueString, valueCode, valueDateTime, value, valueBoolean, code, valueInteger]
        isSummary: false
      concept:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CodeSystem']
        isModifier: false
        short: Child Concepts (is-a/contains/categorizes)
        index: 48
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: CodeSystem.concept.concept}
        isSummary: false
    maxLength: 0
    base: {max: '*', min: 0, path: CodeSystem.concept}
    required: [code]
    isSummary: false
  caseSensitive:
    isModifier: false
    short: If code comparison is case sensitive
    index: 15
    comments: 'If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel''s law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.'
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.caseSensitive}
    isSummary: true
  version:
    isModifier: false
    short: Logical identifier for this version (Coding.version)
    index: 2
    comments: There may be multiple resource versions of the code system that have the same identifier.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: CodeSystem.version}
    isSummary: true
  contact:
    isModifier: false
    short: Contact details of the publisher
    index: 7
    comments: May be a web site, an email address, a telephone number, etc.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      name:
        isModifier: false
        short: Name of an individual to contact
        index: 8
        comments: If there is no named individual, the telecom is for the organization as a whole.
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: CodeSystem.contact.name}
        isSummary: true
      telecom:
        isModifier: false
        short: Contact details for individual or publisher
        index: 9
        type: ContactPoint
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: CodeSystem.contact.telecom}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: CodeSystem.contact}
    isSummary: true
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CodeSystem
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status, content]