2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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

Profile Structured Data Capture Value Set - Definitions

Todo

Definitions for the valueset-sdc-structureddatacapturevalueset Profile.

ValueSet(StructuredDataCaptureValueSet)
Definition

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

Control1..1
Requirements
Comments
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 defines its own codes (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:define)))
vsd-5: Value set SHALL contain either a define, a compose, or an expansion element (xpath: exists(f:define) or exists(f:compose) or exists(f:expansion))
vsd-7: A defined code system (if present) SHALL have a different identifier to the value set itself (xpath: not(f:define/f:system/@value = f:identifier/@value))
ValueSet.id
Definition

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

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typeboolean
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/valueset-category)
Definition

Identifies the value set as belonging to a particular set. For example "demographics", "lab", "clinical research", etc. Might also be used to tie a value set to particular usage projects.

Control0..*
BindingClassifications for valuesets. Can include such concepts as "demographics", "lab", "clinical research". Might also be used to tie a value set to particular usage projects
TypeCodeableConcept
Requirements
Comments

The categories chosen will vary widely depending on the purpose of the value set repository.

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

The uri that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).

Control0..1
Typeuri
Requirements
Comments
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
Requirements
Comments

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

ValueSet.version
Definition

The identifier that is 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
Requirements
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.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
Requirements
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 Value Set 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.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..*
Requirements
Comments

May be a web site, an email address, a telephone number (tel:), etc.

ValueSet.contact.id
Definition

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

Control0..1
Typeid
Requirements
Comments
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
Requirements
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
Requirements
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
Requirements
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
Requirements
Comments
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
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.requirements
Definition

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

Control0..1
Typestring
Requirements
Comments

This element does not describe the usage of the value set (that's 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
Requirements
Alternate NamesLicense, Restrictions
Comments

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

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 ValueSetStatus
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Identify when/if the value set should be used.

Comments

Allows filtering of valuesets that are appropriate for use vs. not.

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

Allows filtering of valuesets that are appropriate for use vs. not.

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.

Comments
ValueSet.date
Definition

The date that the value set status was last changed.

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.

ValueSet.stableDate
Definition

If a Stability Date is expanded by evaluating the Content Logical Definition using the current version of all referenced code system(s) and value sets as of the Stability Date.

Control0..1
Typedate
Requirements
Comments

With a defined Stability Date the value set is considered "Static". Otherwise, the value set is considered to be "Dynamic" and may have different expansions as underlying code systems and/or value sets evolve.

ValueSet.define
Definition

When value set defines its own codes.

Control0..1 This element is affected by the following invariants: vsd-5
Must Supporttrue
Requirements
Comments
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.define.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.define.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
Requirements
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.define.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
Requirements
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.define.system
Definition

URI to identify the code system.

Control1..1
Typeuri
Must Supporttrue
Requirements
Comments
ValueSet.define.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
Requirements
Comments
ValueSet.define.caseSensitive
Definition

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

Control0..1
Typeboolean
Must Supporttrue
Requirements
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.define.concept(concept)
Definition

Concepts in the code system.

Control0..*
Must Supporttrue
Requirements
Comments
ValueSet.define.concept.id
Definition

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

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.define.concept.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.define.concept.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.define.concept.extension.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
Requirements
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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.define.concept.extension.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
Comments

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

ValueSet.define.concept.extension.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.define.concept.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

ValueSet.define.concept.extension.value[x]
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).

Control0..1
Type*
Requirements
Comments
ValueSet.define.concept.extension (http://hl7.org/fhir/ExtensionDefinition/valueset-conceptOrder)
Definition

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

Control0..1
Typeinteger
Requirements
Comments
ValueSet.define.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
Requirements
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.define.concept.code
Definition

Code that identifies concept.

Control1..1
Typecode
Must Supporttrue
Requirements
Comments
ValueSet.define.concept.abstract
Definition

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

Control0..1
Typeboolean
Must Supporttrue
Requirements
Comments
Default Valuefalse
ValueSet.define.concept.display
Definition

Text to Display to the user.

Control0..1
Typestring
Must Supporttrue
Requirements
Comments
ValueSet.define.concept.display.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
Requirements
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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.define.concept.display.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
Comments

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

ValueSet.define.concept.display.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.define.concept.display.value
Definition

The actual value

Control0..1
Typexsd:string
Requirements
Comments
ValueSet.define.concept.definition
Definition

The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.

Control0..1
Typestring
Must Supporttrue
Requirements
Comments
ValueSet.define.concept.designation(designation)
Definition

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

Control0..*
Requirements

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

Comments
ValueSet.define.concept.designation.id
Definition

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

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

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

ValueSet.define.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 SHOULD be taken from Designation Use; other codes may be used where these codes are not suitable
TypeCoding
Requirements
Comments

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

ValueSet.define.concept.designation.value
Definition

The text value for this designation.

Control1..1
Typestring
Requirements
Comments
ValueSet.define.concept.concept
Definition

Child Concepts (is-a / contains).

Control0..*
TypeSee concept
Must Supporttrue
Requirements
Comments
ValueSet.compose
Definition

When value set includes codes from elsewhere.

Control0..1 This element is affected by the following invariants: vsd-5
Must Supporttrue
Requirements
Comments
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
Requirements
Comments
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
Requirements
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
Requirements
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.

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

The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a literal reference to a value set definition (not an expansion). If the reference is a logical one, it may not reference a actual FHIR value set resource; in this case, the referenced definition of a set of coded values 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
Must Supporttrue
Requirements
Comments

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

ValueSet.compose.include.id
Definition

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

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

The code system from which the selected codes come from.

Control1..1
Typeuri
Must Supporttrue
Requirements
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
Requirements
Comments

This is used when selecting the descendents 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..*
Typecode
Must Supporttrue
Requirements
Comments

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

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.compose.include.concept.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.compose.include.concept.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.compose.include.concept.extension.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
Requirements
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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.compose.include.concept.extension.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.compose.include.concept.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

ValueSet.compose.include.concept.extension.value[x]
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).

Control0..1
Type*
Requirements
Comments
ValueSet.compose.include.concept.extension (http://hl7.org/fhir/ExtensionDefinition/valueset-conceptOrder)
Definition

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

Control0..1
Typeinteger
Requirements
Comments
ValueSet.compose.include.concept.extension (http://hl7.org/fhir/ExtensionDefinition/valueset-display)
Definition

The display name for the code. I.e. ValueSet.define.concept.display (or its equivalent).

Control0..*
Typestring
Requirements
Comments
ValueSet.compose.include.concept.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.compose.include.concept.extension.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
Requirements
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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.compose.include.concept.extension.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.compose.include.concept.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

ValueSet.compose.include.concept.extension.value[x]
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).

Control0..1
Type*
Requirements
Comments
ValueSet.compose.include.concept.value
Definition

Primitive value for code

Control0..1
Typexsd:string
Requirements
Comments
ValueSet.compose.include.concept.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.compose.include.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
Requirements
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.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
Requirements
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
Requirements
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
Requirements
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.designation
Definition

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

Control0..*
TypeSee designation
Requirements
Comments
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..*
Must Supporttrue
Requirements
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
Requirements
Comments
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
Requirements
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
Requirements
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
Requirements
Comments
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
Requirements
Comments
ValueSet.compose.include.filter.value
Definition

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

Control1..1
Typecode
Must Supporttrue
Requirements
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
Requirements
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
Must Supporttrue
Requirements
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
Requirements
Comments
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
Requirements
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
Requirements
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.

Control0..1
TypeIdentifier
Must Supporttrue
Requirements
Comments
ValueSet.expansion.timestamp
Definition

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

Control1..1
TypedateTime
Must Supporttrue
Requirements
Comments

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

ValueSet.expansion.contains(contains)
Definition

The codes that are contained in the value set expansion.

Control0..*
Must Supporttrue
Requirements
Comments
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:display/@value = 'true'))
ValueSet.expansion.contains.id
Definition

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

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.expansion.contains.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.expansion.contains.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
ValueSet.expansion.contains.extension.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
Requirements
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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
ValueSet.expansion.contains.extension.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.expansion.contains.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

ValueSet.expansion.contains.extension.value[x]
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).

Control0..1
Type*
Requirements
Comments
ValueSet.expansion.contains.extension (http://hl7.org/fhir/ExtensionDefinition/valueset-conceptOrder)
Definition

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

Control0..1
Typeinteger
Requirements
Comments
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
Requirements
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

The system in which the code for this item in the expansion is defined.

Control0..1
Typeuri
Must Supporttrue
Requirements
Comments
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
Requirements
Comments

This shouldn't be understood to exclude its use for searchig (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
Requirements
Comments

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

ValueSet.expansion.contains.code
Definition

Code - if blank, this is not a choosable code.

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

User display for the concept.

Control0..1 This element is affected by the following invariants: vsd-6
Typestring
Must Supporttrue
Requirements
Comments
ValueSet.expansion.contains.display.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
Requirements
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.

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

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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/ExtensionDefinition/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
Typestring
Requirements
Comments
ValueSet.expansion.contains.display.value
Definition

The actual value

Control0..1
Typexsd:string
Requirements
Comments
ValueSet.expansion.contains.contains
Definition

Codes contained in this concept.

Control0..*
TypeSee contains
Must Supporttrue
Requirements
Comments