description: Base StructureDefinition for CodeSystem Resource package_name: hl7.fhir.core derivation: specialization name: CodeSystem type: CodeSystem elements: description: {short: Natural language description of the code system, comments: 'This description can be used to capture details such as why the code system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.', type: markdown, index: 10} date: {short: Date this was last changed, 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, isSummary: true, index: 9} versionNeeded: {short: If definitions are not stable, 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, isSummary: true, index: 19} publisher: {short: Name of the publisher (Organization or individual), comments: 'Usually an organization, but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.', type: string, isSummary: true, index: 7} jurisdiction: {short: Intended jurisdiction for code system (if applicable), type: CodeableConcept, array: true, isSummary: true, index: 12} purpose: {short: Why this code system is defined, comments: 'This element does not describe the usage of the code system (See, e.g, the comments element, or relatedArtifacts), rather it''s for traceability of ''''why'''' the resource is either needed or ''''why'''' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.', type: markdown, index: 13} content: {short: not-present | examplar | fragment | complete, type: code, isSummary: true, index: 20} property: short: Additional information supplied about each concept type: BackboneElement array: true isSummary: true index: 27 elements: code: {type: code, short: 'Identifies the property on the concepts, and when referred to in operations', isSummary: true, index: 28} uri: {type: uri, short: Formal identifier for the property, isSummary: true, index: 29} description: {type: string, short: 'Why the property is defined, and/or what it conveys', isSummary: true, index: 30} type: {short: code | Coding | string | integer | boolean | dateTime, type: code, isSummary: true, index: 31} required: [type, code] name: {short: Name for this code system (Computer friendly), comments: The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly., type: string, isSummary: true, index: 3} useContext: {short: Content intends to support these contexts, comments: 'When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.', type: UsageContext, array: true, isSummary: true, index: 11} copyright: {short: Use and/or publishing restrictions, comments: 'null Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.', type: markdown, index: 14} experimental: {isModifier: true, short: 'If for testing purposes, not real usage', comments: Allows filtering of code system that are appropriate for use vs. not., type: boolean, isSummary: true, index: 6} title: {type: string, short: Name for this code system (Human friendly), isSummary: true, index: 4} filter: type: BackboneElement short: Filter that can be used in a value set isSummary: true array: true index: 22 elements: code: {type: code, short: Code that identifies the filter, isSummary: true, index: 23} description: {type: string, short: How or why the filter is used, isSummary: true, index: 24} operator: {min: 1, short: Operators that can be used with filter, type: code, array: true, isSummary: true, index: 25} value: {type: string, short: What to use for the value, isSummary: true, index: 26} required: [operator, value, code] compositional: {short: If code system defines a post-composition grammar, comments: 'Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.', type: boolean, isSummary: true, index: 18} status: {isModifier: true, short: draft | active | retired, comments: Allows filtering of code system that are appropriate for use vs. not., type: code, isSummary: true, index: 5} hierarchyMeaning: {short: grouped-by | is-a | part-of | classified-with, type: code, isSummary: true, index: 17} valueSet: {short: Canonical URL for value set with entire code system, comments: 'Thedefinition of the value set SHALL include all codes from this code system, and it SHALL be immutable.', type: uri, isSummary: true, index: 16} count: {short: Total concepts in the code system, 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, isSummary: true, index: 21} url: {short: Logical uri to reference this code system (globally unique) (Coding.system), comments: 'Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.', type: uri, isSummary: true, index: 0} identifier: {short: Additional identifier for the code system, comments: 'Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this code system outside of FHIR, where the logical URL is not possible to use.', type: Identifier, isSummary: true, index: 1} concept: short: Concepts in the code system comments: If this is empty, it means that the code system resource does not represent the content of the code system. type: BackboneElement array: true index: 32 elements: code: {type: code, short: Code that identifies concept, index: 33} display: {type: string, short: Text to display to the user, index: 34} definition: {type: string, short: Formal definition, index: 35} designation: type: BackboneElement short: Additional representations for the concept array: true index: 36 elements: language: {short: Human language of the designation, comments: 'In the absence of a language, the resource language applies.', type: code, index: 37} use: {short: Details how this designation would be used, comments: 'If no use is provided, the designation can be assumed to be suitable for general display to a human user.', type: Coding, index: 38} value: {type: string, short: The text value for this designation, index: 39} required: [value] property: type: BackboneElement short: Property value for the concept array: true index: 40 elements: code: {type: code, short: Reference to CodeSystem.property.code, index: 41} value: short: Value of the property for this concept choices: [valueCode, valueCoding, valueString, valueInteger, valueBoolean, valueDateTime] index: 43 valueCode: {type: code, short: Value of the property for this concept, choiceOf: value, index: 44} valueCoding: {type: Coding, short: Value of the property for this concept, choiceOf: value, index: 45} valueString: {type: string, short: Value of the property for this concept, choiceOf: value, index: 46} valueInteger: {type: integer, 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: 48} valueDateTime: {type: dateTime, short: Value of the property for this concept, choiceOf: value, index: 49} required: [valueCoding, valueString, valueCode, 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: 50 required: [code] caseSensitive: {short: If code comparison is case sensitive, 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, isSummary: true, index: 15} version: {short: Business version of the code system (Coding.version), comments: There may be multiple different instances of a code system that have the same identifier but different versions., type: string, isSummary: true, index: 2} contact: {short: Contact details for the publisher, comments: 'May be a web site, an email address, a telephone number, etc.', type: ContactDetail, array: true, isSummary: true, index: 8} package_version: 1.8.0 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/CodeSystem base: http://hl7.org/fhir/StructureDefinition/DomainResource version: null required: [status, content]