Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

B.6.1.4 StructureDefinition: SDC-ValueSet - Detailed Descriptions

Definitions for the sdc-valueset Profile.

ValueSet(SDC-ValueSet)
Definition

Sets expectations for SDC-conformant systems around value set support for representing permitted question answers.

Control0..*
TypeValueSet
InvariantsDefined on this element
vsd-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set includes and inline code system (xpath: not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:codeSystem)))
vsd-5: Value set SHALL contain at least one of a codeSystem, a compose, or an expansion element (xpath: exists(f:codeSystem) or exists(f:compose) or exists(f:expansion))
vsd-7: A defined code system (if present) SHALL have a different url than the value set url (xpath: not(f:codeSystem/f:system/@value = f:url/@value))
ValueSet.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. Bundles always have an id, though it is usually a generated UUID.

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

ValueSet.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
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).

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

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

ValueSet.extension (http://hl7.org/fhir/StructureDefinition/styleSensitive)
Definition

Indicates that the style extensions in this resource are essential to the interpretation of the styled text and that it cannot be rendered without the style without losing essential information.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If set to true, all systems that claim to support this extension and which render elements of the resource containing this extension SHALL either render the content as required by the style extensions defined by this profile that are present in the resource or shall (if safe to do so based on their own rules), omit entirely the styled content they cannot render in accordance with the extensions.

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

ValueSet.url
Definition

An absolute URL that is used to identify this value set 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 value set is (or will be) published.

Control0..1
Typeuri
Must Supporttrue
ValueSet.identifier
Definition

Formal identifier that is used to identify this value set 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.

ValueSet.version
Definition

Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.

Control0..1
Typestring
Comments

There may be multiple resource versions of the value set that have the same identifier.

ValueSet.name
Definition

A free text natural language name describing the value set.

Control1..1
Typestring
Must Supporttrue
Requirements

Support human navigation.

Comments

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

ValueSet.status
Definition

The status of the value set.

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

Identify when/if the value set should be used.

Comments

Allows filtering of value set instances that are appropriate (or not) for use.

ValueSet.experimental
Definition

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

Control0..1
Typeboolean
Must Supporttrue
Comments

Allows filtering of value sets that are appropriate for use vs. not.

ValueSet.publisher
Definition

The name of the individual or organization that published the value set.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the value set. May also allow for contact.

Comments

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

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

ValueSet.contact.id
Definition

unique id for the element within a resource (for internal references).

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

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

ValueSet.contact.name
Definition

The name of an individual to contact regarding the value set.

Control0..1
Typestring
Comments

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

ValueSet.contact.telecom
Definition

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

Control0..*
TypeContactPoint
ValueSet.date
Definition

The date that the value set 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
Must Supporttrue
Requirements

Need to know when a value set 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 value set. Additional specific dates may be added as extensions.

ValueSet.lockedDate
Definition

If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date.

Control0..1
Typedate
Must Supporttrue
Comments

With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.

ValueSet.description
Definition

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

Control1..1
Typestring
Must Supporttrue
Requirements

Human understandability.

Alternate NamesScope, Purpose
Comments

The description is not intended to describe the semantics of the Value Set - 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 value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.

ValueSet.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 value set 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
Must Supporttrue
Requirements

Assist in searching for appropriate content.

ValueSet.immutable
Definition

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

Control1..1
Typeboolean
Must Supporttrue
Comments

Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.

ValueSet.requirements
Definition

Explains why this value set is needed and why it has been constrained as it has.

Control0..1
Typestring
Comments

This element does not describe the usage of the value set (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.

ValueSet.copyright
Definition

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

Control0..1
Typestring
Alternate NamesLicense, Restrictions
Comments

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

ValueSet.extensible
Definition

Whether this is intended to be used with an extensible binding or not.

Control1..1
Typeboolean
Must Supporttrue
Requirements

It is not required to say whether this intent applies.

ValueSet.codeSystem
Definition

A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly.

Control0..1 This element is affected by the following invariants: vsd-5
TypeBackboneElement
Must Supporttrue
Comments

All code systems defined as part of a FHIR value set have an implicit valueset that includes all of the codes in the code system - the value set in which they are defined.

InvariantsDefined on this element
vsd-3: 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))
vsd-8: Codes must be unique (xpath: count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value)))
ValueSet.codeSystem.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.codeSystem.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.

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

ValueSet.codeSystem.system
Definition

An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.

Control1..1
Typeuri
Must Supporttrue
Comments

The reference is not required to point to any specific kind of definition, but the more information that can be provided, the more useful it is for implementers. Best practice is to resolve to a computable definition of the code system (either a value set, or some other format). Terminology servers MAY validate this reference (e.g. when accepting PUT/POST), and MAY make additional rules about what kind of content it refers to.

ValueSet.codeSystem.version
Definition

The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.

Control0..1
Typestring
Must Supporttrue
ValueSet.codeSystem.caseSensitive
Definition

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

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

ValueSet.codeSystem.concept(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
Must Supporttrue
ValueSet.codeSystem.concept.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.codeSystem.concept.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.codeSystem.concept.extension (http://hl7.org/fhir/StructureDefinition/valueset-label)
Definition

The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.codeSystem.concept.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.codeSystem.concept.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
ValueSet.codeSystem.concept.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/valueset-label
ValueSet.codeSystem.concept.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
ValueSet.codeSystem.concept.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.codeSystem.concept.extension.valueString.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.codeSystem.concept.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.codeSystem.concept.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.codeSystem.concept.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.codeSystem.concept.extension (http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder)
Definition

Identifies the relative order in which concepts within the value set should be presented to a user.

Control0..1
TypeExtension (Extension Type: integer)
ValueSet.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.

ValueSet.codeSystem.concept.code
Definition

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

Control1..1
Typecode
Must Supporttrue
ValueSet.codeSystem.concept.abstract
Definition

If this code is not for use as a real concept.

Control0..1
Typeboolean
Must Supporttrue
Default Valuefalse
ValueSet.codeSystem.concept.display
Definition

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

Control0..1
Typestring
Must Supporttrue
ValueSet.codeSystem.concept.display.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.codeSystem.concept.display.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.codeSystem.concept.display.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.codeSystem.concept.display.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.codeSystem.concept.display.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.codeSystem.concept.definition
Definition

The formal definition of the concept. The value set 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.

Control0..1
Typestring
Must Supporttrue
ValueSet.codeSystem.concept.designation(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.

ValueSet.codeSystem.concept.designation.id
Definition

unique id for the element within a resource (for internal references).

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

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

ValueSet.codeSystem.concept.designation.language
Definition

The language this designation is defined for.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

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

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

ValueSet.codeSystem.concept.designation.value
Definition

The text value for this designation.

Control1..1
Typestring
ValueSet.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 concept
Must Supporttrue
ValueSet.compose
Definition

A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.

Control0..1 This element is affected by the following invariants: vsd-5
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
vsd-1: A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import))
ValueSet.compose.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.compose.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.

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

ValueSet.compose.import
Definition

Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri.

Control0..* This element is affected by the following invariants: vsd-1
Typeuri
Must Supporttrue
Comments

The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.

ValueSet.compose.include(include)
Definition

Include one or more codes from a code system.

Control0..* This element is affected by the following invariants: vsd-1
TypeBackboneElement
Must Supporttrue
Comments

If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes.

InvariantsDefined on this element
vsd-11: Cannot have both concept and filter (xpath: not(exists(f:concept)) or not(exists(f:filter)))
ValueSet.compose.include.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.compose.include.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.

ValueSet.compose.include.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.

ValueSet.compose.include.system
Definition

An absolute URI which is the code system from which the selected codes come from.

Control1..1
Typeuri
Must Supporttrue
Comments

See ''Coding.system'' for further documentation.

ValueSet.compose.include.version
Definition

The version of the code system that the codes are selected from.

Control0..1
Typestring
Must Supporttrue
Comments

This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.

ValueSet.compose.include.concept
Definition

Specifies a concept to be included or excluded.

Control0..* This element is affected by the following invariants: vsd-11
TypeBackboneElement
Must Supporttrue
Comments

The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.

ValueSet.compose.include.concept.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.compose.include.concept.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.compose.include.concept.extension (http://hl7.org/fhir/StructureDefinition/valueset-label)
Definition

The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.compose.include.concept.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.compose.include.concept.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
ValueSet.compose.include.concept.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/valueset-label
ValueSet.compose.include.concept.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
ValueSet.compose.include.concept.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.compose.include.concept.extension.valueString.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.compose.include.concept.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.compose.include.concept.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.compose.include.concept.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.compose.include.concept.extension (http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder)
Definition

Identifies the relative order in which concepts within the value set should be presented to a user.

Control0..1
TypeExtension (Extension Type: integer)
ValueSet.compose.include.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.

ValueSet.compose.include.concept.code
Definition

Specifies a code for the concept to be included or excluded.

Control1..1
Typecode
Must Supporttrue
Comments

Expressions are allowed if defined by the underlying code system.

ValueSet.compose.include.concept.display
Definition

The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.

Control0..1
Typestring
Must Supporttrue
Comments

The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.

ValueSet.compose.include.concept.display.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.compose.include.concept.display.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.compose.include.concept.display.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.compose.include.concept.display.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.compose.include.concept.display.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.compose.include.concept.designation
Definition

Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

Control0..*
TypeSee designation
ValueSet.compose.include.filter
Definition

Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.

Control0..* This element is affected by the following invariants: vsd-11
TypeBackboneElement
Must Supporttrue
Comments

Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.

ValueSet.compose.include.filter.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.compose.include.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.

ValueSet.compose.include.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.

ValueSet.compose.include.filter.property
Definition

A code that identifies a property defined in the code system.

Control1..1
Typecode
Must Supporttrue
ValueSet.compose.include.filter.op
Definition

The kind of operation to perform as a part of the filter criteria.

Control1..1
BindingThe kind of operation to perform as a part of a property based filter.
The codes SHALL be taken from FilterOperator
Typecode
Must Supporttrue
ValueSet.compose.include.filter.value
Definition

The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value.

Control1..1
Typecode
Must Supporttrue
Comments

Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.

ValueSet.compose.exclude
Definition

Exclude one or more codes from the value set.

Control0..* This element is affected by the following invariants: vsd-2
TypeSee include
Must Supporttrue
Comments

Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.

ValueSet.expansion
Definition

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Control0..1 This element is affected by the following invariants: vsd-5
TypeBackboneElement
Must Supporttrue
Comments

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.

ValueSet.expansion.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.expansion.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.

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

ValueSet.expansion.identifier
Definition

An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.

Control1..1
Typeuri
Must Supporttrue
Comments

Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).

ValueSet.expansion.timestamp
Definition

The time at which the expansion was produced by the expanding system.

Control1..1
TypedateTime
Must Supporttrue
Comments

This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.

ValueSet.expansion.total
Definition

The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

Control0..1
Typeinteger
Comments

Paging only applies to flat expansions.

ValueSet.expansion.offset
Definition

If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.

Control0..1
Typeinteger
Comments

Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.

Meaning if MissingPaging is not being used
ValueSet.expansion.parameter
Definition

A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.

Control0..*
TypeBackboneElement
Comments

The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).

ValueSet.expansion.parameter.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.expansion.parameter.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.

ValueSet.expansion.parameter.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.

ValueSet.expansion.parameter.name
Definition

The name of the parameter.

Control1..1
Typestring
Comments

The names are assigned at the discretion of the server.

ValueSet.expansion.parameter.value[x]
Definition

The value of the parameter.

Control0..1
TypeChoice of: string, boolean, integer, decimal, uri, code
[x] NoteSee Choice of Data Types for further information about how to use [x]
ValueSet.expansion.contains(contains)
Definition

The codes that are contained in the value set expansion.

Control0..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
vsd-10: Must have a system if a code is present (xpath: exists(f:system) or not(exists(f:code)))
vsd-6: SHALL have a code or a display (xpath: exists(f:code) or exists(f:display))
vsd-9: Must have a code if not abstract (xpath: exists(f:code) or (f:abstract/@value = true()))
ValueSet.expansion.contains.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.expansion.contains.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.expansion.contains.extension (http://hl7.org/fhir/StructureDefinition/valueset-label)
Definition

The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.expansion.contains.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
ValueSet.expansion.contains.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
ValueSet.expansion.contains.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/valueset-label
ValueSet.expansion.contains.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
ValueSet.expansion.contains.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.expansion.contains.extension.valueString.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.expansion.contains.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.expansion.contains.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.expansion.contains.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.expansion.contains.extension (http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder)
Definition

Identifies the relative order in which concepts within the value set should be presented to a user.

Control0..1
TypeExtension (Extension Type: integer)
ValueSet.expansion.contains.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.

ValueSet.expansion.contains.system
Definition

An absolute URI which is the code system in which the code for this item in the expansion is defined.

Control0..1
Typeuri
Must Supporttrue
ValueSet.expansion.contains.abstract
Definition

If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

Control0..1
Typeboolean
Must Supporttrue
Comments

This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.

ValueSet.expansion.contains.version
Definition

The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.

Control0..1
Typestring
Must Supporttrue
Comments

The exact value of the version string is specified by the system from which the code is derived.

ValueSet.expansion.contains.code
Definition

The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

Control0..1 This element is affected by the following invariants: vsd-6
Typecode
Must Supporttrue
ValueSet.expansion.contains.display
Definition

The recommended display for this item in the expansion.

Control0..1 This element is affected by the following invariants: vsd-6
Typestring
Must Supporttrue
ValueSet.expansion.contains.display.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
ValueSet.expansion.contains.display.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
ValueSet.expansion.contains.display.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

ValueSet.expansion.contains.display.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
ValueSet.expansion.contains.display.value
Definition

The actual value

Control0..1
Max Length1048576
ValueSet.expansion.contains.contains
Definition

Other codes and entries contained under this entry in the hierarchy.

Control0..*
TypeSee contains
Must Supporttrue
Comments

If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.