A code system resource specifies a set of codes drawn from one or more code systems.

An absolute URL that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. This is used in [Coding]{datatypes.html#Coding}.system.

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.

Typically, this is used for values that can go in an HL7 v3 II data type.

Used to identify this version of the code system when it is referenced in a specification, model, design or instance (e.g. Coding.version). This is an arbitrary value managed by the profile author manually and the value should be a timestamp. This is used in [Coding]{datatypes.html#Coding}.version.

There may be multiple resource versions of the code system that have the same identifier.

A free text natural language name describing the code system.

Support human navigation.

The name is not expected to be unique. A name should be provided unless the code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a name.

The status of the code system.

Identify when/if the code system should be used.

Allows filtering of code system instances that are appropriate (or not) for use.

This CodeSystem was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

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

The name of the individual or organization that published the code system.

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

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

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

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

The name of an individual to contact regarding the code system.

If there is no named individual, the telecom is for the organization as a whole.

Contact details for individual (if a name was provided) or the publisher.

The date that the code system status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition').

Need to know when a code system was first legal for use or became withdrawn or replaced.

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.

A free text natural language description of the use of the code system - reason for definition, "the semantic space" to be included in the code system, conditions of use, etc. The description may include a list of expected usages for the code system and can also describe the approach taken to build the code system.

Human understandability.

The description is not intended to describe the semantics of the Code System - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a description.

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

Assist in searching for appropriate content.

Explains why this code system is needed and why it has been constrained as it has.

This element does not describe the usage of the code system (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.

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.

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

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

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.

Canonical URL of value set that contains the entire code system.

True If code system defines a post-composition grammar.

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

This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.

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

How much of the content of the code system - the concepts and codes it defines - are represented in this resource.

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.

The count of concepts defined in this resource cannot be more than this value, but may be less for several reasons - see the content value.

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

The code that identifies thise filter when it is used in the instance.

A description of how or why the filter is used.

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

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

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

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.

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

The type of the property value.

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

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

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

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

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.

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

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

The language this designation is defined for.

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

A code that details how this designation would be used.

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

The text value for this designation.

A property value for this concept.

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

The value of this property.

Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts.