FHIR CI-Build

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

Terminology Infrastructure icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

Definitions for the publishablevalueset Profile.

ValueSet
Element Id ValueSet
Definition

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.

Short Display A set of codes drawn from one or more code systems
Cardinality 1..1
Invariants
Inherited by this element
cnl-0WarningName should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ValueSet.id
Element Id ValueSet.id
Definition

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

Short Display Logical id of this artifact
Cardinality 0..1
Type id
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

ValueSet.meta
Element Id ValueSet.meta
Definition

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

Short Display Metadata about the resource
Cardinality 0..1
Type Meta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.implicitRules
Element Id 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short Display A set of rules under which this content was created
Cardinality 0..1
Type uri
Is Modifier true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.language
Element Id ValueSet.language
Definition

The base language in which the resource is written.

Short Display Language of the resource content
Cardinality 0..1
Terminology Binding IETF language tag for a human language
The codes SHALL be taken from All Languages
Type code
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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.text
Element Id ValueSet.text
Definition

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

Short Display Text summary of the resource, for human interpretation
Cardinality 0..1 This element is affected by the following invariants: dom-6
Type Narrative
Alternate Names narrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.contained
Element Id ValueSet.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Short Display Contained, inline Resources
Cardinality 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type Resource
Alternate Names inline 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

ValueSet.extension
Element Id ValueSet.extension
Definition

An Extension

Short Display Extension
Cardinality 0..*
Type Extension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
ValueSet.extension(knowledgeRepresentationLevel)
Element Id ValueSet.extension:knowledgeRepresentationLevel
Definition

Defines a knowledge representation level provided by this knowledge artifact.

Short Display narrative | semi-structured | structured | executable
Cardinality 0..*
Type Extension(KnowledgeRepresentationLevel)
Must Support true
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ValueSet.extension(authoritativeSource)
Element Id ValueSet.extension:authoritativeSource
Definition

A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions.

Short Display Reference to the current trusted source of the ValueSet resource (metadata and definition)
Cardinality 0..1
Type Extension(VSAuthoritativeSource)
Must Support true
Comments

If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ValueSet.extension(trustedExpansion)
Element Id ValueSet.extension:trustedExpansion
Definition

A trusted FHIR terminology server endpoint (the [base] url of the FHIR server) where an expansion of the valueset may be performed.

Short Display Reference to a trusted expansion
Cardinality 0..1
Type Extension(VSTrustedExpansion)
Must Support true
Comments

If the designated "authoritative source" (as specified in the valueset-authoritativeSource extension, if present) is unable to provide a valid expansion, this extension indicates an alternate authoritative source where the value set expansion may be performed. The alternate authoritative source url must reference a FHIR terminology server endpoint (the [base] url of the FHIR server).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.extension(otherTitle)
Element Id ValueSet.extension:otherTitle
Definition

Human readable titles for the valueset.

Short Display Alternative titles
Cardinality 0..*
Type Extension(VSOtherTitle)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.extension(sourceReference)
Element Id ValueSet.extension:sourceReference
Definition

This text is intended to act as a citation to work done elsewhere that is not part of the current stewarding process where the referenced source is in some way a basis of the current value set definition.

Short Display Where did this content come from
Cardinality 0..1
Type Extension(VSSourceReference)
Comments

This is not intended to be a direct link to another value set. It is only intended to support a link or textual description that indicates related material for the value set.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.modifierExtension
Element Id 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.url
Element Id ValueSet.url
Definition

An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.

Short Display Canonical identifier for this value set, represented as a URI (globally unique)
Cardinality 1..1
Type uri
Must Support true
Requirements

Allows the value set to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Inherited by this element
cnl-1WarningURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.identifier
Element Id ValueSet.identifier
Definition

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

Short Display Additional identifier for the value set (business identifier)
Cardinality 0..*
Type Identifier
Must Support true
Requirements

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

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.version
Element Id 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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short Display Business version of the value set
Cardinality 1..1
Type string
Must Support true
Comments

There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.versionAlgorithm[x]
Element Id ValueSet.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which ValueSet is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding null
The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable
Type Choice of: string, Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Must Support true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.name
Element Id ValueSet.name
Definition

A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short Display Name for this value set (computer friendly)
Cardinality 0..1 This element is affected by the following invariants: cnl-0
Type string
Must Support true
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.title
Element Id ValueSet.title
Definition

A short, descriptive, user-friendly title for the value set.

Short Display Name for this value set (human friendly)
Cardinality 1..1
Type string
Must Support true
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.status
Element Id ValueSet.status
Definition

The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding The lifecycle status of an artifact.
The codes SHALL be taken from PublicationStatus
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Must Support true
Comments

Allows filtering of value sets that are appropriate for use versus not.See also the http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription extension for additional status information related to the editorial process.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.experimental
Element Id ValueSet.experimental
Definition

A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short Display For testing purposes, not real usage
Cardinality 1..1
Type boolean
Must Support true
Requirements

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

Comments

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

Meaning if Missing If absent, this resource is treated as though it is not experimental.
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.date
Element Id ValueSet.date
Definition

The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised.

Short Display Date last changed
Cardinality 1..1
Type dateTime
Must Support true
Alternate Names Revision Date
Comments

Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.publisher
Element Id ValueSet.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the value set.

Short Display Name of the publisher/steward (organization or individual)
Cardinality 0..1
Type string
Must Support true
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 is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.contact
Element Id ValueSet.contact
Definition

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

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Must Support true
Comments

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

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.description
Element Id ValueSet.description
Definition

A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.

Short Display Natural language description of the value set
Cardinality 1..1
Type markdown
Must Support true
Comments

Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.useContext
Element Id ValueSet.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.

Short Display The context that the content is intended to support
Cardinality 0..*
Type UsageContext
Must Support true
Requirements

Assist in searching for appropriate content.

Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.jurisdiction
Element Id ValueSet.jurisdiction
Definition

A legal or geographic region in which the value set is intended to be used.

Short Display Intended jurisdiction for value set (if applicable)
Cardinality 0..*
Terminology Binding Countries and regions within which this artifact is targeted for use.
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
Type CodeableConcept
Must Support true
Comments

It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.immutable
Element Id 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.

Short Display Indicates whether or not any change to the content logical definition may occur
Cardinality 0..1
Type boolean
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.purpose
Element Id ValueSet.purpose
Definition

Explanation of why this value set is needed and why it has been designed as it has.

Short Display Why this value set is defined
Cardinality 0..1
Type markdown
Must Support true
Comments

This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.copyright
Element Id 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.

Short Display Use and/or publishing restrictions
Cardinality 0..1
Type markdown
Must Support true
Requirements

Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.

Alternate Names License, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.copyrightLabel
Element Id ValueSet.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Must Support true
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.approvalDate
Element Id ValueSet.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short Display When the ValueSet was approved by publisher
Cardinality 0..1
Type date
Comments

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

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.lastReviewDate
Element Id ValueSet.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short Display When the ValueSet was last reviewed by the publisher
Cardinality 0..1
Type date
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.effectivePeriod
Element Id ValueSet.effectivePeriod
Definition

The period during which the ValueSet content was or is planned to be in active use.

Short Display When the ValueSet is expected to be used
Cardinality 0..1
Type Period
Must Support true
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ValueSet are or are expected to be used instead.

Comments

The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.topic
Element Id ValueSet.topic
Definition

Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.

Short Display E.g. Education, Treatment, Assessment, etc
Cardinality 0..*
Terminology Binding null
For example codes, see Definition Topic
Type CodeableConcept
Must Support true
Requirements

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

Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.author
Element Id ValueSet.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the ValueSet.

Short Display Who authored the ValueSet
Cardinality 0..*
Type ContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.editor
Element Id ValueSet.editor
Definition

An individual or organization primarily responsible for internal coherence of the ValueSet.

Short Display Who edited the ValueSet
Cardinality 0..*
Type ContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.reviewer
Element Id ValueSet.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.

Short Display Who reviewed the ValueSet
Cardinality 0..*
Type ContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.endorser
Element Id ValueSet.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.

Short Display Who endorsed the ValueSet
Cardinality 0..*
Type ContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.relatedArtifact
Element Id ValueSet.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Short Display Additional documentation, citations, etc
Cardinality 0..*
Type RelatedArtifact
Requirements

A ValueSet must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose
Element Id ValueSet.compose
Definition

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

Short Display Content logical definition of the value set (CLD)
Cardinality 0..1
Type BackboneElement
Alternate Names Content Logical Definition, CLD
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.id
Element Id ValueSet.compose.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.compose.extension
Element Id ValueSet.compose.extension
Definition

An Extension

Short Display Extension
Cardinality 0..*
Type Extension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Slicing This element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
ValueSet.compose.extension(composeCreatedBy)
Element Id ValueSet.compose.extension:composeCreatedBy
Definition

User who created the compose for the ValueSet.

Short Display Extension
Cardinality 0..1
Type Extension(VSComposeCreatedBy)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ValueSet.compose.extension(composeCreationDate)
Element Id ValueSet.compose.extension:composeCreationDate
Definition

Date the compose was created.

Short Display Extension
Cardinality 0..1
Type Extension(VSComposeCreationDate)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ValueSet.compose.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.lockedDate
Element Id ValueSet.compose.lockedDate
Definition

The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.

Short Display Fixed date for references with no specified version (transitive)
Cardinality 0..1
Type date
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.inactive
Element Id ValueSet.compose.inactive
Definition

Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).

Short Display Whether inactive codes are in the value set
Cardinality 0..1
Type boolean
Comments

Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.

The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include
Element Id ValueSet.compose.include
Definition

Include one or more codes from a code system or other value set(s).

Short Display Include one or more codes from a code system or other value set(s)
Cardinality 1..*
Type BackboneElement
Comments

All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
vsd-1RuleA value set include/exclude SHALL have a value set or a systemvalueSet.exists() or system.exists()
vsd-2RuleA value set with concepts or filters SHALL include a system(concept.exists() or filter.exists()) implies system.exists()
vsd-3RuleCannot have both concept and filterconcept.empty() or filter.empty()
ValueSet.compose.include.id
Element Id ValueSet.compose.include.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.compose.include.extension
Element Id ValueSet.compose.include.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.system
Element Id ValueSet.compose.include.system
Definition

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

Short Display The system the codes come from
Cardinality 0..1 This element is affected by the following invariants: vsd-2, vsd-1
Type uri
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. See ''Coding.system'' for further documentation about the correct value for the system element. If a contained code system is referenced, the entire canonical url must be provided.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.version
Element Id ValueSet.compose.include.version
Definition

The version of the code system that the codes are selected from, or the special version '*' for all versions.

Short Display Specific version of the code system referred to
Cardinality 0..1
Type string
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 might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept
Element Id ValueSet.compose.include.concept
Definition

Specifies a concept to be included or excluded.

Short Display A concept defined in the system
Cardinality 0..* This element is affected by the following invariants: vsd-2, vsd-3
Type BackboneElement
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.id
Element Id ValueSet.compose.include.concept.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.compose.include.concept.extension
Element Id ValueSet.compose.include.concept.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.code
Element Id ValueSet.compose.include.concept.code
Definition

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

Short Display Code or expression from system
Cardinality 1..1
Type code
Comments

Expressions are allowed if defined by the underlying code system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.display
Element Id 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.

Short Display Text to display for this code for this value set in this valueset
Cardinality 0..1
Type string
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation
Element Id 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.

Short Display Additional representations for this concept
Cardinality 0..*
Type BackboneElement
Comments

Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
vsd-11RuleMust have a value for concept.designation.use if concept.designation.additionalUse is presentadditionalUse.exists() implies use.exists()
ValueSet.compose.include.concept.designation.id
Element Id ValueSet.compose.include.concept.designation.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.compose.include.concept.designation.extension
Element Id ValueSet.compose.include.concept.designation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation.modifierExtension
Element Id ValueSet.compose.include.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation.language
Element Id ValueSet.compose.include.concept.designation.language
Definition

The language this designation is defined for.

Short Display Human language of the designation
Cardinality 0..1
Terminology Binding IETF language tag for a human language
The codes SHALL be taken from All Languages
Type code
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation.use
Element Id ValueSet.compose.include.concept.designation.use
Definition

A code that represents types of uses of designations.

Short Display Types of uses of designations
Cardinality 0..1 This element is affected by the following invariants: vsd-11
Terminology Binding Details 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
Type Coding
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation.additionalUse
Element Id ValueSet.compose.include.concept.designation.additionalUse
Definition

Additional codes that detail how this designation would be used, if there is more than one use.

Short Display Additional ways how this designation would be used
Cardinality 0..* This element is affected by the following invariants: vsd-11
Terminology Binding Details 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
Type Coding
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.concept.designation.value
Element Id ValueSet.compose.include.concept.designation.value
Definition

The text value for this designation.

Short Display The text value for this designation
Cardinality 1..1
Type string
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter
Element Id ValueSet.compose.include.filter
Definition

Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true.

Short Display Select codes/concepts by their properties (including relationships)
Cardinality 0..* This element is affected by the following invariants: vsd-2, vsd-3
Type BackboneElement
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter.id
Element Id ValueSet.compose.include.filter.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.compose.include.filter.extension
Element Id ValueSet.compose.include.filter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter.property
Element Id ValueSet.compose.include.filter.property
Definition

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

Short Display A property/filter defined by the code system
Cardinality 1..1
Type code
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter.op
Element Id ValueSet.compose.include.filter.op
Definition

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

Short Display = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Cardinality 1..1
Terminology Binding The kind of operation to perform as a part of a property based filter.
The codes SHALL be taken from Filter Operator
Type code
Comments

In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.filter.value
Element Id ValueSet.compose.include.filter.value
Definition

ValueSet.compose.include.filter.value is represented as a string, and the string value must be one of the three types below: When the filter operation (ValueSet.compose.include.filter.op) is equal to "regex", the value (ValueSet.compose.include.filter.value) is a regex expression. This is used to match string values (including integer and decimal, if necessary). When the filter operation (ValueSet.compose.include.filter.op) is equal to "exists", the value (ValueSet.compose.include.filter.value) is a boolean and must be equal to "true" or "false". For all other filter operations (ValueSet.compose.include.filter.op) the value (ValueSet.compose.include.filter.value) represents a code.

Short Display Code from the system, or regex criteria, or boolean value for exists
Cardinality 1..1
Type string
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.valueSet
Element Id ValueSet.compose.include.valueSet
Definition

Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets.

Short Display Select the contents included in this value set
Cardinality 0..* This element is affected by the following invariants: vsd-1
Type canonical(ValueSet)
Comments

The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set icon, or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.include.copyright
Element Id ValueSet.compose.include.copyright
Definition

A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).

Short Display A copyright statement for the specific code system included in the value set
Cardinality 0..1
Type markdown
Must Support true
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.exclude
Element Id ValueSet.compose.exclude
Definition

Exclude one or more codes from the value set based on code system filters and/or other value sets.

Short Display Explicitly exclude codes from a code system or other value sets
Cardinality 0..*
Type See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.compose.property
Element Id ValueSet.compose.property
Definition

A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.

Short Display Property to return if client doesn't override
Cardinality 0..*
Type string
Comments

Note that property names can clash, so using a URI is recommended.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion
Element Id 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.

Short Display Used when the value set is "expanded"
Cardinality 0..1
Type BackboneElement
Comments

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.

Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.id
Element Id ValueSet.expansion.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.extension
Element Id ValueSet.expansion.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.identifier
Element Id ValueSet.expansion.identifier
Definition

An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

Short Display Identifies the value set expansion (business identifier)
Cardinality 0..1
Type uri
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.next
Element Id ValueSet.expansion.next
Definition

As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.

Short Display Opaque urls for paging through expansion results
Cardinality 0..1
Type uri
Comments

Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.timestamp
Element Id ValueSet.expansion.timestamp
Definition

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

Short Display Time ValueSet expansion happened
Cardinality 1..1
Type dateTime
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.total
Element Id 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.

Short Display Total number of codes in the expansion
Cardinality 0..1
Type integer
Comments

Paging only applies to flat expansions.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.offset
Element Id 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.

Short Display Offset at which this resource starts
Cardinality 0..1
Type integer
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 Missing Paging is not being used
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.parameter
Element Id 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.

Short Display Parameter that controlled the expansion process
Cardinality 0..*
Type BackboneElement
Comments

The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.id
Element Id ValueSet.expansion.parameter.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.parameter.extension
Element Id ValueSet.expansion.parameter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.name
Element Id ValueSet.expansion.parameter.name
Definition

Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.

Short Display Name as assigned by the client or server
Cardinality 1..1
Type string
Comments

The names are assigned at the discretion of the server.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.value[x]
Element Id ValueSet.expansion.parameter.value[x]
Definition

The value of the parameter.

Short Display Value of the named parameter
Cardinality 0..1
Type Choice of: string, boolean, integer, decimal, uri, code, dateTime
[x] Note See Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.property
Element Id ValueSet.expansion.property
Definition

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

Short Display Additional information supplied about each concept
Cardinality 0..*
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.property.id
Element Id ValueSet.expansion.property.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.property.extension
Element Id ValueSet.expansion.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.property.modifierExtension
Element Id ValueSet.expansion.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.property.code
Element Id ValueSet.expansion.property.code
Definition

A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.

Short Display Identifies the property on the concepts, and when referred to in operations
Cardinality 1..1
Type code
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.property.uri
Element Id ValueSet.expansion.property.uri
Definition

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

Short Display Formal identifier for the property
Cardinality 0..1
Type uri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains
Element Id ValueSet.expansion.contains
Definition

The codes that are contained in the value set expansion.

Short Display Codes in the value set
Cardinality 0..*
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
vsd-6RuleSHALL have a code or a displaycode.exists() or display.exists()
vsd-9RuleSHALL have a code if not abstractcode.exists() or abstract = true
vsd-10RuleSHALL have a system if a code is presentcode.empty() or system.exists()
ValueSet.expansion.contains.id
Element Id ValueSet.expansion.contains.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.contains.extension
Element Id ValueSet.expansion.contains.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.modifierExtension
Element Id 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.system
Element Id 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.

Short Display System value for the code
Cardinality 0..1 This element is affected by the following invariants: vsd-10
Type uri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.abstract
Element Id 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.

Short Display If user cannot select this entry
Cardinality 0..1 This element is affected by the following invariants: vsd-9
Type boolean
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.

Meaning if Missing If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.inactive
Element Id ValueSet.expansion.contains.inactive
Definition

If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).

Short Display If concept is inactive in the code system
Cardinality 0..1
Type boolean
Comments

This should only have a value if the concept is inactive.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.version
Element Id ValueSet.expansion.contains.version
Definition

The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Short Display Version in which this code/display is defined
Cardinality 0..1
Type string
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.code
Element Id 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.

Short Display Code - if blank, this is not a selectable code
Cardinality 0..1 This element is affected by the following invariants: vsd-6, vsd-9, vsd-10
Type code
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.display
Element Id ValueSet.expansion.contains.display
Definition

The recommended display for this item in the expansion.

Short Display User display for the concept
Cardinality 0..1 This element is affected by the following invariants: vsd-6
Type string
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.designation
Element Id ValueSet.expansion.contains.designation
Definition

Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.

Short Display Additional representations for this item
Cardinality 0..*
Type See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation
Comments

The designations provided must be based on the value set and code system definitions.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property
Element Id ValueSet.expansion.contains.property
Definition

A property value for this concept.

Short Display Property value for the concept
Cardinality 0..*
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.id
Element Id ValueSet.expansion.contains.property.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.contains.property.extension
Element Id ValueSet.expansion.contains.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.modifierExtension
Element Id ValueSet.expansion.contains.property.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.code
Element Id ValueSet.expansion.contains.property.code
Definition

A code that is a reference to ValueSet.expansion.property.code.

Short Display Reference to ValueSet.expansion.property.code
Cardinality 1..1
Type code
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.value[x]
Element Id ValueSet.expansion.contains.property.value[x]
Definition

The value of this property.

Short Display Value of the property for this concept
Cardinality 1..1
Type Choice of: code, Coding, string, integer, boolean, dateTime, decimal
[x] Note See Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.subProperty
Element Id ValueSet.expansion.contains.property.subProperty
Definition

A subproperty value for this concept.

Short Display SubProperty value for the concept
Cardinality 0..*
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.subProperty.id
Element Id ValueSet.expansion.contains.property.subProperty.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.expansion.contains.property.subProperty.extension
Element Id ValueSet.expansion.contains.property.subProperty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.subProperty.modifierExtension
Element Id ValueSet.expansion.contains.property.subProperty.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.subProperty.code
Element Id ValueSet.expansion.contains.property.subProperty.code
Definition

A code that is a reference to ValueSet.expansion.property.code.

Short Display Reference to ValueSet.expansion.property.code
Cardinality 1..1
Type code
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.property.subProperty.value[x]
Element Id ValueSet.expansion.contains.property.subProperty.value[x]
Definition

The value of this subproperty.

Short Display Value of the subproperty for this concept
Cardinality 1..1
Type Choice of: code, Coding, string, integer, boolean, dateTime, decimal
[x] Note See Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.expansion.contains.contains
Element Id ValueSet.expansion.contains.contains
Definition

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

Short Display Codes contained under this entry
Cardinality 0..*
Type See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.scope
Element Id ValueSet.scope
Definition

Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

Short Display Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
Cardinality 0..1
Type BackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.scope.id
Element Id ValueSet.scope.id
Definition

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

Short Display Unique id for inter-element referencing
Cardinality 0..1 This element is affected by the following invariants: ele-1
Type string
ValueSet.scope.extension
Element Id ValueSet.scope.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Display Additional content defined by implementations
Cardinality 0..*
Type Extension
Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.scope.modifierExtension
Element Id ValueSet.scope.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Display Extensions that cannot be ignored even if unrecognized
Cardinality 0..*
Type Extension
Is Modifier true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.scope.inclusionCriteria
Element Id ValueSet.scope.inclusionCriteria
Definition

Criteria describing which concepts or codes should be included and why.

Short Display Criteria describing which concepts or codes should be included and why
Cardinality 0..1
Type markdown
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ValueSet.scope.exclusionCriteria
Element Id ValueSet.scope.exclusionCriteria
Definition

Criteria describing which concepts or codes should be excluded and why.

Short Display Criteria describing which concepts or codes should be excluded and why
Cardinality 0..1
Type markdown
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())