FHIR CI-Build

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

Vocabulary icon Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the CodeSystem resource.

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
Cardinality0..*
TypeMetadataResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name 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-1Rule Within a code system definition, all the codes SHALL be uniqueconcept.exists() implies concept.code.combine(%resource.concept.descendants().concept.code).isDistinct()
csd-2Warning If there is a explicit hierarchy, a hierarchyMeaning should be providedconcept.concept.exists() implies hierarchyMeaning.exists()
csd-3Warning If there is a implicit hierarchy, a hierarchyMeaning should be providedconcept.where(property.code = 'parent' or property.code = 'child').exists() implies hierarchyMeaning.exists()
csd-4Rule If the code system content = supplement, it must nominate what it's a supplement forCodeSystem.content = 'supplement' implies CodeSystem.supplements.exists()
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)
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
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
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
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)
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
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.

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)
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.

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
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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
Affect this element
cnl-0Warning Name 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}')
CodeSystem.title
Element IdCodeSystem.title
Definition

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

Short DisplayName for this code system (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

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

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 BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration)
Summarytrue
Comments

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

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
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

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

CodeSystem.date
Element IdCodeSystem.date
Definition

The date (and optionally time) when the code system was published. 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
Summarytrue
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 or be found by consulting Provenances associated with past versions of the resource.

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
Requirements

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

Summarytrue
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.

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
Summarytrue
Comments

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

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
Cardinality0..1
Typemarkdown
Alternate NamesScope; Purpose
Summaryfalse
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).

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.

Summarytrue
Comments

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

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 BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.

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
Summaryfalse
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.

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
Summaryfalse
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.

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
Summaryfalse
Comments

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

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
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.

Summaryfalse
Comments

If specified, this date follows the original approval date.

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.

Summarytrue
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 measure intended to be used for the year 2016 might be published in 2015.

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 BindingDefinitionTopic (Example)
TypeCodeableConcept
Requirements

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

Summaryfalse
Comments

This element provides topical categorization and keywords for the CodeSystem, as opposed to the more structured context-of-use information provided in the useContext element

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
Summaryfalse
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
Summaryfalse
CodeSystem.reviewer
Element IdCodeSystem.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the CodeSystem.

Short DisplayWho reviewed the CodeSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
CodeSystem.endorser
Element IdCodeSystem.endorser
Definition

An individual or organization responsible for officially endorsing the CodeSystem for use in some setting.

Short DisplayWho endorsed the CodeSystem
Cardinality0..*
TypeContactDetail
Summaryfalse
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.

Summaryfalse
Comments

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

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
Cardinality0..1
Typeboolean
Summarytrue
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.

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)
Summarytrue
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.

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
Terminology BindingCodeSystemHierarchyMeaning (Required)
Typecode
Summarytrue
Comments

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

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
Summarytrue
Comments

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

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
Summarytrue
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.

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
Terminology BindingCodeSystemContentMode (Required)
Typecode
Summarytrue
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
Typecanonical(CodeSystem)
Summarytrue
Comments

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

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
Summarytrue
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.

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..*
Summarytrue
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.

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
Summarytrue
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
Summarytrue
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 BindingFilterOperator (Required)
Typecode
Summarytrue
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
Summarytrue
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..*
Summarytrue
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.

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
Summarytrue
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
Summarytrue
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
Summarytrue
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 BindingPropertyType (Required)
Typecode
Summarytrue
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..*
Summaryfalse
Comments

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

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
Typecode
Summaryfalse
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
Summaryfalse
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
Summaryfalse
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..*
Requirements

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

Summaryfalse
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
Defined on this element
csd-5Rule Must have a value for concept.designation.use if concept.designation.additionalUse is presentadditionalUse.exists() implies use.exists()
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 BindingCommon Languages (Preferred but limited to All Languages)
Typecode
Summaryfalse
Comments

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

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
Terminology BindingDesignation Use (Extensible)
TypeCoding
Summaryfalse
Comments

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

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..*
Terminology BindingDesignation Use (Extensible)
TypeCoding
Summaryfalse
Comments

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

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
Summaryfalse
CodeSystem.concept.property
Element IdCodeSystem.concept.property
Definition

A property value for this concept.

Short DisplayProperty value for the concept
Cardinality0..*
Summaryfalse
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
Typecode
Summaryfalse
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
Typecode|Coding|string|integer|boolean|dateTime|decimal
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
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..*
TypeSee CodeSystem.concept
Summaryfalse