FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Terminology Infrastructure icon Work Group Maturity Level: 0Trial Use Use Context: Any

Definitions for the shareablecodesystem Profile.

CodeSystem
Element IdCodeSystem
Definition

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.

Short DisplayDeclares the existence of and describes a code system or code system supplement
Cardinality1..1
Invariants
Inherited by this element
cnl-0WarningName should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
csd-1RuleWithin a code system definition, all the codes SHALL be uniqueconcept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
scs-1RuleIf a codesystem contains nested concepts, it must specify hierarchyMeaningconcept.concept.exists() implies hierarchyMeaning.exists()
csd-2WarningIf there is an explicit hierarchy, a hierarchyMeaning should be providedconcept.concept.exists() implies hierarchyMeaning.exists()
scs-2RuleIf a codesystem contains example, fragment, or complete content, it must have at least one conceptcontent in ( 'example' | 'fragment' | 'complete' ) implies concept.exists()
csd-3WarningIf there is an implicit hierarchy, a hierarchyMeaning should be providedconcept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4RuleIf the code system content = supplement, it must nominate what it's a supplement forCodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
CodeSystem.id
Element IdCodeSystem.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short DisplayLogical id of this artifact
Cardinality0..1
Typeid
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

CodeSystem.meta
Element IdCodeSystem.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short DisplayMetadata about the resource
Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.implicitRules
Element IdCodeSystem.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short DisplayA set of rules under which this content was created
Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.language
Element IdCodeSystem.language
Definition

The base language in which the resource is written.

Short DisplayLanguage of the resource content
Cardinality0..1
Terminology BindingIETF language tag for a human language
The codes SHALL be taken from All Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.text
Element IdCodeSystem.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short DisplayText summary of the resource, for human interpretation
Cardinality0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.contained
Element IdCodeSystem.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Short DisplayContained, inline Resources
Cardinality0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

CodeSystem.extension
Element IdCodeSystem.extension
Definition

An Extension

Short DisplayExtension
Cardinality0..*
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
CodeSystem.extension(knowledgeRepresentationLevel)
Element IdCodeSystem.extension:knowledgeRepresentationLevel
Definition

Defines a knowledge representation level provided by this knowledge artifact.

Short Displaynarrative | semi-structured | structured | executable
Cardinality0..*
TypeExtension(KnowledgeRepresentationLevel)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
CodeSystem.modifierExtension
Element IdCodeSystem.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.url
Element IdCodeSystem.url
Definition

An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.

Short DisplayCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Cardinality1..1
Typeuri
Must Supporttrue
Requirements

Allows the code system to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Inherited by this element
cnl-1WarningURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.identifier
Element IdCodeSystem.identifier
Definition

A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short DisplayAdditional identifier for the code system (business identifier)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.version
Element IdCodeSystem.version
Definition

The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.

Short DisplayBusiness version of the code system (Coding.version)
Cardinality1..1
Typestring
Must Supporttrue
Comments

There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.versionAlgorithm[x]
Element IdCodeSystem.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which CodeSystem is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology Bindingnull
The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable
TypeChoice of: string, Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Must Supporttrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.name
Element IdCodeSystem.name
Definition

A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short DisplayName for this code system (computer friendly)
Cardinality0..1 This element is affected by the following invariants: cnl-0
Typestring
Must Supporttrue
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.title
Element IdCodeSystem.title
Definition

A short, descriptive, user-friendly title for the code system.

Short DisplayName for this code system (human friendly)
Cardinality1..1
Typestring
Must Supporttrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.status
Element IdCodeSystem.status
Definition

The status of this code system. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingThe lifecycle status of an artifact.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration)
Must Supporttrue
Comments

Allows filtering of code systems that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.experimental
Element IdCodeSystem.experimental
Definition

A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality1..1
Typeboolean
Must Supporttrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.

Comments

Allows filtering of code systems that are appropriate for use versus not.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.date
Element IdCodeSystem.date
Definition

The date (and optionally time) when the code system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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 or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.publisher
Element IdCodeSystem.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the code system.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Must Supporttrue
Requirements

Helps establish the "authority/credibility" of the code system. May also allow for contact.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.contact
Element IdCodeSystem.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.description
Element IdCodeSystem.description
Definition

A free text natural language description of the code system from a consumer's perspective.

Short DisplayNatural language description of the code system
Cardinality1..1
Typemarkdown
Must Supporttrue
Alternate NamesScope, Purpose
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.useContext
Element IdCodeSystem.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.jurisdiction
Element IdCodeSystem.jurisdiction
Definition

A legal or geographic region in which the code system is intended to be used.

Short DisplayIntended jurisdiction for code system (if applicable)
Cardinality0..*
Terminology BindingCountries and regions within which this artifact is targeted for use.
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.purpose
Element IdCodeSystem.purpose
Definition

Explanation of why this code system is needed and why it has been designed as it has.

Short DisplayWhy this code system is defined
Cardinality0..1
Typemarkdown
Comments

This element does not describe the usage of the code system. Instead, it provides 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.copyright
Element IdCodeSystem.copyright
Definition

A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.

Alternate NamesLicense, Restrictions
Comments

... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.copyrightLabel
Element IdCodeSystem.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.approvalDate
Element IdCodeSystem.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the CodeSystem was approved by publisher
Cardinality0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.lastReviewDate
Element IdCodeSystem.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the CodeSystem was last reviewed by the publisher
Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.effectivePeriod
Element IdCodeSystem.effectivePeriod
Definition

The period during which the CodeSystem content was or is planned to be in active use.

Short DisplayWhen the CodeSystem is expected to be used
Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the CodeSystem are or are expected to be used instead.

Comments

The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.topic
Element IdCodeSystem.topic
Definition

Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching.

Short DisplayE.g. Education, Treatment, Assessment, etc
Cardinality0..*
Terminology Bindingnull
For example codes, see Definition Topic
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the CodeSystem so that it can be found by topical and keyword searches.

Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.author
Element IdCodeSystem.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.

Short DisplayWho authored the CodeSystem
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.editor
Element IdCodeSystem.editor
Definition

An individual or organization primarily responsible for internal coherence of the CodeSystem.

Short DisplayWho edited the CodeSystem
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.reviewer
Element IdCodeSystem.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem.

Short DisplayWho reviewed the CodeSystem
Cardinality0..*
TypeContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.endorser
Element IdCodeSystem.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting.

Short DisplayWho endorsed the CodeSystem
Cardinality0..*
TypeContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.relatedArtifact
Element IdCodeSystem.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Short DisplayAdditional documentation, citations, etc
Cardinality0..*
TypeRelatedArtifact
Requirements

A CodeSystem must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.caseSensitive
Element IdCodeSystem.caseSensitive
Definition

If code comparison is case sensitive when codes within this system are compared to each other.

Short DisplayIf code comparison is case sensitive
Cardinality1..1
Typeboolean
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.valueSet
Element IdCodeSystem.valueSet
Definition

Canonical reference to the value set that contains all codes in the code system independent of code status.

Short DisplayCanonical reference to the value set with entire code system
Cardinality0..1
Typecanonical(ValueSet)
Comments

The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.hierarchyMeaning
Element IdCodeSystem.hierarchyMeaning
Definition

The meaning of the hierarchy of concepts as represented in this resource.

Short Displaygrouped-by | is-a | part-of | classified-with
Cardinality0..1 This element is affected by the following invariants: csd-2, csd-3, scs-1
Terminology BindingThe meaning of the hierarchy of concepts in a code system.
The codes SHALL be taken from Code System Hierarchy Meaning
Typecode
Must Supporttrue
Comments

Note that other representations might have a different hierarchy or none at all, and represent the information using properties.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.compositional
Element IdCodeSystem.compositional
Definition

The code system defines a compositional (post-coordination) grammar.

Short DisplayIf code system defines a compositional grammar
Cardinality0..1
Typeboolean
Alternate Namesgrammar
Comments

Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.versionNeeded
Element IdCodeSystem.versionNeeded
Definition

This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

Short DisplayIf definitions are not stable
Cardinality0..1
Typeboolean
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'.

Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.content
Element IdCodeSystem.content
Definition

The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

Short Displaynot-present | example | fragment | complete | supplement
Cardinality1..1 This element is affected by the following invariants: csd-4, scs-2
Terminology BindingThe extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
The codes SHALL be taken from Code System Content Mode
Typecode
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.supplements
Element IdCodeSystem.supplements
Definition

The canonical URL of the code system that this code system supplement is adding designations and properties to.

Short DisplayCanonical URL of Code System this adds designations and properties to
Cardinality0..1 This element is affected by the following invariants: csd-4
Typecanonical(CodeSystem)
Comments

The most common use of a code system supplement is to add additional language support.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.count
Element IdCodeSystem.count
Definition

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

Short DisplayTotal concepts in the code system
Cardinality0..1
TypeunsignedInt
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 element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter
Element IdCodeSystem.filter
Definition

A filter that can be used in a value set compose statement when selecting concepts using a filter.

Short DisplayFilter that can be used in a value set
Cardinality0..*
TypeBackboneElement
Comments

Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.id
Element IdCodeSystem.filter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
CodeSystem.filter.extension
Element IdCodeSystem.filter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.modifierExtension
Element IdCodeSystem.filter.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.code
Element IdCodeSystem.filter.code
Definition

The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter.

Short DisplayCode that identifies the filter
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.description
Element IdCodeSystem.filter.description
Definition

A description of how or why the filter is used.

Short DisplayHow or why the filter is used
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.operator
Element IdCodeSystem.filter.operator
Definition

A list of operators that can be used with the filter.

Short Display= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Cardinality1..*
Terminology BindingThe kind of operation to perform as a part of a property based filter.
The codes SHALL be taken from Filter Operator
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.filter.value
Element IdCodeSystem.filter.value
Definition

A description of what the value for the filter should be.

Short DisplayWhat to use for the value
Cardinality1..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property
Element IdCodeSystem.property
Definition

A property defines an additional slot through which additional information can be provided about a concept.

Short DisplayAdditional information supplied about each concept
Cardinality0..*
TypeBackboneElement
Comments

Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.id
Element IdCodeSystem.property.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
CodeSystem.property.extension
Element IdCodeSystem.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.modifierExtension
Element IdCodeSystem.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.code
Element IdCodeSystem.property.code
Definition

A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.

Short DisplayIdentifies the property on the concepts, and when referred to in operations
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.uri
Element IdCodeSystem.property.uri
Definition

Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.

Short DisplayFormal identifier for the property
Cardinality0..1
Typeuri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.description
Element IdCodeSystem.property.description
Definition

A description of the property- why it is defined, and how its value might be used.

Short DisplayWhy the property is defined, and/or what it conveys
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.property.type
Element IdCodeSystem.property.type
Definition

The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).

Short Displaycode | Coding | string | integer | boolean | dateTime | decimal
Cardinality1..1
Terminology BindingThe type of a property value.
The codes SHALL be taken from Property Type
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept
Element IdCodeSystem.concept
Definition

Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

Short DisplayConcepts in the code system
Cardinality0..* This element is affected by the following invariants: csd-1, scs-2
TypeBackboneElement
Must Supporttrue
Comments

If this is empty, it means that the code system resource does not represent the content of the code system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.id
Element IdCodeSystem.concept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
CodeSystem.concept.extension
Element IdCodeSystem.concept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.modifierExtension
Element IdCodeSystem.concept.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.code
Element IdCodeSystem.concept.code
Definition

A code - a text symbol - that uniquely identifies the concept within the code system.

Short DisplayCode that identifies concept
Cardinality1..1 This element is affected by the following invariants: csd-1
Typecode
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.display
Element IdCodeSystem.concept.display
Definition

A human readable string that is the recommended default way to present this concept to a user.

Short DisplayText to display to the user
Cardinality0..1
Typestring
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.definition
Element IdCodeSystem.concept.definition
Definition

The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.

Short DisplayFormal definition
Cardinality0..1
Typestring
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation
Element IdCodeSystem.concept.designation
Definition

Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

Short DisplayAdditional representations for the concept
Cardinality0..*
TypeBackboneElement
Requirements

Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.

Comments

Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
csd-5RuleMust have a value for concept.designation.use if concept.designation.additionalUse is presentadditionalUse.exists() implies use.exists()
CodeSystem.concept.designation.id
Element IdCodeSystem.concept.designation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
CodeSystem.concept.designation.extension
Element IdCodeSystem.concept.designation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation.modifierExtension
Element IdCodeSystem.concept.designation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation.language
Element IdCodeSystem.concept.designation.language
Definition

The language this designation is defined for.

Short DisplayHuman language of the designation
Cardinality0..1
Terminology BindingIETF language tag for a human language
The codes SHALL be taken from All Languages
Typecode
Comments

In the absence of a language, the resource language applies.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation.use
Element IdCodeSystem.concept.designation.use
Definition

A code that details how this designation would be used.

Short DisplayDetails how this designation would be used
Cardinality0..1 This element is affected by the following invariants: csd-5
Terminology BindingDetails of how a designation would be used.
The codes SHALL be taken from Designation Use; other codes may be used where these codes are not suitable
TypeCoding
Comments

If no use is provided, the designation can be assumed to be suitable for general display to a human user.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation.additionalUse
Element IdCodeSystem.concept.designation.additionalUse
Definition

Additional codes that detail how this designation would be used, if there is more than one use.

Short DisplayAdditional ways how this designation would be used
Cardinality0..* This element is affected by the following invariants: csd-5
Terminology BindingDetails of how a designation would be used.
The codes SHALL be taken from Designation Use; other codes may be used where these codes are not suitable
TypeCoding
Comments

This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.designation.value
Element IdCodeSystem.concept.designation.value
Definition

The text value for this designation.

Short DisplayThe text value for this designation
Cardinality1..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.property
Element IdCodeSystem.concept.property
Definition

A property value for this concept.

Short DisplayProperty value for the concept
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.property.id
Element IdCodeSystem.concept.property.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
CodeSystem.concept.property.extension
Element IdCodeSystem.concept.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.property.modifierExtension
Element IdCodeSystem.concept.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.property.code
Element IdCodeSystem.concept.property.code
Definition

A code that is a reference to CodeSystem.property.code.

Short DisplayReference to CodeSystem.property.code
Cardinality1..1 This element is affected by the following invariants: csd-3
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.property.value[x]
Element IdCodeSystem.concept.property.value[x]
Definition

The value of this property.

Short DisplayValue of the property for this concept
Cardinality1..1
TypeChoice of: code, Coding, string, integer, boolean, dateTime, decimal
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
CodeSystem.concept.concept
Element IdCodeSystem.concept.concept
Definition

Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.

Short DisplayChild Concepts (is-a/contains/categorizes)
Cardinality0..* This element is affected by the following invariants: csd-1, csd-2, scs-1
TypeSee ttp://hl7.org/fhir/StructureDefinition/CodeSystem#CodeSystem.concept
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())