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