STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.11.13.2.4 StructureDefinition: ShareableCodeSystem - Detailed Descriptions

Definitions for the shareablecodesystem Profile.

CodeSystem(ShareableCodeSystem)
Definition

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

Control1..1
InvariantsDefined on this element
csd-1: Within a code system definition, all the codes SHALL be unique (xpath: count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept))
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained))
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)))
CodeSystem.id
Definition

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

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

CodeSystem.meta
Definition

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

Control0..1
TypeMeta
CodeSystem.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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

CodeSystem.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
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).

CodeSystem.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have 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 in formation is added later.

CodeSystem.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

CodeSystem.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.url
Definition

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.

Control1..1
Typeuri
CodeSystem.identifier
Definition

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.

Control0..1
TypeIdentifier
Comments

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

CodeSystem.version
Definition

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.

Control1..1
Typestring
Comments

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

CodeSystem.name
Definition

A free text natural language name describing the code system.

Control1..1
Typestring
Requirements

Support human navigation.

Comments

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.

CodeSystem.status
Definition

The status of the code system.

Control1..1
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from ConformanceResourceStatus
Typecode
Is Modifiertrue
Requirements

Identify when/if the code system should be used.

Comments

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

CodeSystem.experimental
Definition

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

Control1..1
Typeboolean
Comments

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

CodeSystem.publisher
Definition

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

Control1..1
Typestring
Requirements

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

Alternate Namessteward
Comments

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

CodeSystem.contact
Definition

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

Control0..*
TypeBackboneElement
Comments

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

CodeSystem.contact.id
Definition

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

Control0..1
Typestring
CodeSystem.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.contact.name
Definition

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

Control0..1
Typestring
Comments

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

CodeSystem.contact.telecom
Definition

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

Control0..*
TypeContactPoint
CodeSystem.date
Definition

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

Control0..1
TypedateTime
Requirements

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

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.

CodeSystem.description
Definition

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.

Control1..1
Typemarkdown
Requirements

Human understandability.

Alternate NamesScope, Purpose, scope
Comments

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.

CodeSystem.useContext
Definition

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.

Control0..*
BindingIndicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.
The codes SHALL be taken from Context of Use ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Assist in searching for appropriate content.

CodeSystem.requirements
Definition

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

Control0..1
Typemarkdown
Comments

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.

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

Control0..1
Typestring
Alternate NamesLicense, Restrictions
Comments

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

CodeSystem.caseSensitive
Definition

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

Control1..1
Typeboolean
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
Definition

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

Control0..1
Typeuri
CodeSystem.hierarchyMeaning
Definition

The meaning of the heirarchy of concepts.

Control0..1
BindingThe meaning of the hierarchy of concepts in a code system
The codes SHALL be taken from CodeSystemHierarchyMeaning
Typecode
CodeSystem.compositional
Definition

True If code system defines a post-composition grammar.

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

CodeSystem.versionNeeded
Definition

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.

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

CodeSystem.content
Definition

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

Control1..1
BindingHow much 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 CodeSystemContentMode
Typecode
CodeSystem.count
Definition

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.

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

CodeSystem.filter
Definition

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

Control0..*
TypeBackboneElement
CodeSystem.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.

Control0..1
Typestring
CodeSystem.filter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.filter.code
Definition

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

Control1..1
Typecode
CodeSystem.filter.description
Definition

A description of how or why the filter is used.

Control0..1
Typestring
CodeSystem.filter.operator
Definition

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

Control1..*
BindingThe kind of operation to perform as a part of a property based filter.
The codes SHALL be taken from FilterOperator
Typecode
CodeSystem.filter.value
Definition

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

Control1..1
Typestring
CodeSystem.property
Definition

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

Control0..*
TypeBackboneElement
CodeSystem.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.

Control0..1
Typestring
CodeSystem.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

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

Control1..1
Typecode
CodeSystem.property.uri
Definition

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

Control0..1
Typeuri
CodeSystem.property.description
Definition

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

Control0..1
Typestring
CodeSystem.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 anotherr defined concept).

Control1..1
BindingThe type of a property value
The codes SHALL be taken from PropertyType
Typecode
CodeSystem.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 meaning of the hierarchical relationships are.

Control1..*
TypeBackboneElement
Comments

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

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

Control0..1
Typestring
CodeSystem.concept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.concept.code
Definition

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

Control1..1
Typecode
CodeSystem.concept.display
Definition

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

Control1..1
Typestring
CodeSystem.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.

Control1..1
Typestring
CodeSystem.concept.designation
Definition

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

Control0..*
TypeBackboneElement
Requirements

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

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

Control0..1
Typestring
CodeSystem.concept.designation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.concept.designation.language
Definition

The language this designation is defined for.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

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

CodeSystem.concept.designation.use
Definition

A code that details how this designation would be used.

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

CodeSystem.concept.designation.value
Definition

The text value for this designation.

Control1..1
Typestring
CodeSystem.concept.property
Definition

A property value for this concept.

Control0..*
TypeBackboneElement
CodeSystem.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.

Control0..1
Typestring
CodeSystem.concept.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

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

CodeSystem.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
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.

CodeSystem.concept.property.code
Definition

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

Control1..1
Typecode
CodeSystem.concept.property.value[x]
Definition

The value of this property.

Control1..1
TypeChoice of: code, Coding, string, integer, boolean, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
CodeSystem.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) and can only be determined by examining the definitions of the concepts.

Control0..*
TypeSee CodeSystem:shareablecodesystem.concept