Page Status: draft updated 2025-08-08

ValueSet

Page index

General information
Profile
Supported operations

General information

The ValueSet resource represents a set of codes that is used in a specific context.

Scope and Usage

This profile is used when querying ValueSets stored and maintained by the Swedish e-Health Agency.

Background and Context

The codes in a value set are a combination of codes from one or many code systems. The value set can include all codes in a code system, or only a subset of the codes from the code system. See ValueSets for more information on value sets.

Coded values are used in many different resources. Elements of type 'CodeableConcept', 'code' or 'Coding' are bound to a value set in a profile. However when data is exchanged in run time, coded values are described by the code and the code system, not by the value set.

Profile

HVOValueSet (ValueSet)	C		ValueSet	There are no (further) constraints on this element Element id ValueSet Short description A set of codes drawn from one or more code systems 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. Data type ValueSet Constraints cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')` Mappings w5: conformance.behavior,conformance.terminology rim: N/A
id	S Σ	0..1	id	There are no (further) constraints on this element Element id ValueSet.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id ValueSet.meta Short description Metadata about the resource 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id ValueSet.implicitRules Short description A set of rules under which this content was created 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id ValueSet.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text	C	0..1	Narrative	There are no (further) constraints on this element Element id ValueSet.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Conditions The cardinality or value of this element may be affected by these constraints: dom-6 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained	C	0..*	Resource	There are no (further) constraints on this element Element id ValueSet.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Conditions The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings rim: N/A
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
url	S Σ C	0..1	uri	There are no (further) constraints on this element Element id ValueSet.url Short description Canonical identifier for this value set, represented as a URI (globally unique) 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. 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. Data type uri Constraints cnl-1: URL should not contain \| or # - these characters make processing canonical references problematic `exists() implies matches('^[^\|# ]+$')` ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: N/A
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id ValueSet.identifier Short description Additional identifier for the value set (business 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. 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. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier objimpl: no-gen-base
version	S Σ	0..1	string	There are no (further) constraints on this element Element id ValueSet.version Short description Business version of the value set 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.version
versionAlgorithm[x]	Σ	0..1	Binding	There are no (further) constraints on this element Element id ValueSet.versionAlgorithm[x] Short description How to compare versions Definition Indicates the mechanism used to compare versions to determine which ValueSet is more current. 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. Binding VersionAlgorithm (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
versionAlgorithmString			string	There are no (further) constraints on this element Data type string
versionAlgorithmCoding			Coding	There are no (further) constraints on this element Data type Coding
name	S Σ C	0..1	string	There are no (further) constraints on this element Element id ValueSet.name Short description Name for this value set (computer friendly) 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. 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. Data type string Conditions The cardinality or value of this element may be affected by these constraints: cnl-0 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
title	Σ	0..1	string	There are no (further) constraints on this element Element id ValueSet.title Short description Name for this value set (human friendly) Definition A short, descriptive, user-friendly title for the value set. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id ValueSet.status Short description draft \| active \| retired \| unknown 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. 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. Data type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element id ValueSet.experimental Short description For testing purposes, not real usage 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. 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 when missing If absent, this resource is treated as though it is not experimental. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
date	S Σ	0..1	dateTime	There are no (further) constraints on this element Element id ValueSet.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised. 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: N/A
publisher	S Σ	0..1	string	There are no (further) constraints on this element Element id ValueSet.publisher Short description Name of the publisher/steward (organization or individual) Definition The name of the organization or individual responsible for the release and ongoing maintenance of the value set. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element id ValueSet.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
description	S	0..1	markdown	There are no (further) constraints on this element Element id ValueSet.description Short description Natural language description of the value set 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. 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). Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element id ValueSet.useContext Short description The context that the content is intended to support 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. 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. Data type UsageContext Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id ValueSet.jurisdiction Short description Intended jurisdiction for value set (if applicable) Definition A legal or geographic region in which the value set is intended to be used. 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.) Data type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. JurisdictionValueSet (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
immutable	Σ	0..1	boolean	There are no (further) constraints on this element Element id ValueSet.immutable Short description Indicates whether or not any change to the content logical definition may occur 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. 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
purpose		0..1	markdown	There are no (further) constraints on this element Element id ValueSet.purpose Short description Why this value set is defined Definition Explanation of why this value set is needed and why it has been designed as it has. 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. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.why[x] objimpl: no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element id ValueSet.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions 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. Requirements Consumers must be able to determine any legal restrictions on the use of the value set and/or its content. 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. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings objimpl: no-gen-base
copyrightLabel		0..1	string	There are no (further) constraints on this element Element id ValueSet.copyrightLabel Short description Copyright holder and year(s) 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'). 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
approvalDate		0..1	date	There are no (further) constraints on this element Element id ValueSet.approvalDate Short description When the ValueSet was approved by publisher Definition The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. 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. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings objimpl: no-gen-base
lastReviewDate		0..1	date	There are no (further) constraints on this element Element id ValueSet.lastReviewDate Short description When the ValueSet was last reviewed by the publisher Definition The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval 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. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings objimpl: no-gen-base
effectivePeriod	Σ	0..1	Period	There are no (further) constraints on this element Element id ValueSet.effectivePeriod Short description When the ValueSet is expected to be used Definition The period during which the ValueSet content was or is planned to be in active use. 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. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings objimpl: no-gen-base
topic		0..*	CodeableConcept	There are no (further) constraints on this element Element id ValueSet.topic Short description E.g. Education, Treatment, Assessment, etc 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. 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) Data type CodeableConcept Binding DefinitionTopic (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
author		0..*	ContactDetail	There are no (further) constraints on this element Element id ValueSet.author Short description Who authored the ValueSet Definition An individiual or organization primarily involved in the creation and maintenance of the ValueSet. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
editor		0..*	ContactDetail	There are no (further) constraints on this element Element id ValueSet.editor Short description Who edited the ValueSet Definition An individual or organization primarily responsible for internal coherence of the ValueSet. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
reviewer		0..*	ContactDetail	There are no (further) constraints on this element Element id ValueSet.reviewer Short description Who reviewed the ValueSet Definition An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet. Comments See guidance around (not) making local changes to elements here. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
endorser		0..*	ContactDetail	There are no (further) constraints on this element Element id ValueSet.endorser Short description Who endorsed the ValueSet Definition An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting. Comments See guidance around (not) making local changes to elements here. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
relatedArtifact		0..*	RelatedArtifact	There are no (further) constraints on this element Element id ValueSet.relatedArtifact Short description Additional documentation, citations, etc Definition Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. 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. Data type RelatedArtifact Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
compose	S	0..1	BackboneElement	There are no (further) constraints on this element Element id ValueSet.compose Short description Content logical definition of the value set (CLD) Alternate names Content Logical Definition, CLD 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). Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
lockedDate	Σ	0..1	date	There are no (further) constraints on this element Element id ValueSet.compose.lockedDate Short description Fixed date for references with no specified version (transitive) 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. 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. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.init
inactive	Σ	0..1	boolean	There are no (further) constraints on this element Element id ValueSet.compose.inactive Short description Whether inactive codes are in the value set 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). 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). Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
include	S Σ C	1..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.compose.include Short description Include one or more codes from a code system or other value set(s) Definition Include one or more codes from a code system or other value set(s). 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'. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-1: A value set include/exclude SHALL have a value set or a system `valueSet.exists() or system.exists()` vsd-2: A value set with concepts or filters SHALL include a system `(concept.exists() or filter.exists()) implies system.exists()` vsd-3: Cannot have both concept and filter `concept.empty() or filter.empty()` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
system	S Σ C	0..1	uri	There are no (further) constraints on this element Element id ValueSet.compose.include.system Short description The system the codes come from Definition An absolute URI which is the code system from which the selected codes come from. 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. Data type uri Conditions The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
version	S Σ	0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.version Short description Specific version of the code system referred to Definition The version of the code system that the codes are selected from, or the special version '' for all versions. 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. Data type* string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
concept	C	0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.compose.include.concept Short description A concept defined in the system Definition Specifies a concept to be included or excluded. 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. Data type BackboneElement Conditions The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-3 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	Element id ValueSet.compose.include.concept.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
definition	S C	0..1	Extension(string)	Element id ValueSet.compose.include.concept.extension:definition Short description A definition for this code Alternate names extensions, user content Definition A definition that describes the meaning of this code when used as part of this value set. Comments This is provided for when the source code system doesn't actually provide a definition (there are many such). Providing an definition for a code SHOULD NOT be done where the underlying code system provides a definition. Data type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/valueset-concept-definition Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
code	S	1..1	code	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.code Short description Code or expression from system Definition Specifies a code for the concept to be included or excluded. Comments Expressions are allowed if defined by the underlying code system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
display	S	0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.display Short description Text to display for this code for this value set in this valueset 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
designation	S C	0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation Short description Additional representations for this concept Definition Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present `additionalUse.exists() implies use.exists()`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
language		0..1	codeBinding	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.language Short description Human language of the designation Definition The language this designation is defined for. Comments In the absence of a language, the resource language applies. Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
use	S C	0..1	CodingBinding	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use Short description Types of uses of designations Definition A code that represents types of uses of designations. Comments If no use is provided, the designation can be assumed to be suitable for general display to a human user. Data type Coding Binding Details of how a designation would be used. DesignationUse (extensible) Conditions The cardinality or value of this element may be affected by these constraints: vsd-11 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	id	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type id Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	S Σ	0..1	uri	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. 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. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	0..1	code	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Data type code Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	S Σ C	0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.use.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
additionalUse	C	0..*	CodingBinding	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.additionalUse Short description Additional ways how this designation would be used Definition Additional codes that detail how this designation would be used, if there is more than one use. Comments This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. Data type Coding Binding Details of how a designation would be used. DesignationUse (extensible) Conditions The cardinality or value of this element may be affected by these constraints: vsd-11 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value	S	1..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.concept.designation.value Short description The text value for this designation Definition The text value for this designation. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
filter	Σ C	0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.compose.include.filter Short description Select codes/concepts by their properties (including relationships) 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. 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. Data type BackboneElement Conditions The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-3 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
property	Σ	1..1	code	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.property Short description A property/filter defined by the code system Definition A code that identifies a property or a filter defined in the code system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
op	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.op Short description = \| is-a \| descendent-of \| is-not-a \| regex \| in \| not-in \| generalizes \| child-of \| descendent-leaf \| exists Definition The kind of operation to perform as a part of the filter criteria. 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. Data type code Binding The kind of operation to perform as a part of a property based filter. FilterOperator (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
value	Σ	1..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.filter.value Short description Code from the system, or regex criteria, or boolean value for exists Definition The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'. Comments Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueSet	Σ C	0..*	canonical(ValueSet)	There are no (further) constraints on this element Element id ValueSet.compose.include.valueSet Short description Select the contents included in this value set 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. Comments The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, 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. Data type canonical(ValueSet) Conditions The cardinality or value of this element may be affected by these constraints: vsd-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
copyright		0..1	string	There are no (further) constraints on this element Element id ValueSet.compose.include.copyright Short description A copyright statement for the specific code system included in the value set 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). Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
exclude		0..*	see (include)	There are no (further) constraints on this element Element id ValueSet.compose.exclude Short description Explicitly exclude codes from a code system or other value sets Definition Exclude one or more codes from the value set based on code system filters and/or other value sets. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
property		0..*	string	There are no (further) constraints on this element Element id ValueSet.compose.property Short description Property to return if client doesn't override 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. Comments* Note that property names can clash, so using a URI is recommended. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
expansion		0..1	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion Short description Used when the value set is "expanded" 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. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier		0..1	uri	There are no (further) constraints on this element Element id ValueSet.expansion.identifier Short description Identifies the value set expansion (business 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. Comments Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd). Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
next		0..1	uri	There are no (further) constraints on this element Element id ValueSet.expansion.next Short description Opaque urls for paging through expansion results Definition As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
timestamp		1..1	dateTime	There are no (further) constraints on this element Element id ValueSet.expansion.timestamp Short description Time ValueSet expansion happened Definition The time at which the expansion was produced by the expanding system. 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
total		0..1	integer	There are no (further) constraints on this element Element id ValueSet.expansion.total Short description Total number of codes in the expansion 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. Comments Paging only applies to flat expansions. Data type integer Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
offset		0..1	integer	There are no (further) constraints on this element Element id ValueSet.expansion.offset Short description Offset at which this resource starts 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. 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 when missing Paging is not being used Data type integer Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
parameter		0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion.parameter Short description Parameter that controlled the expansion process 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. 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). Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.parameter.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.parameter.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.parameter.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
name		1..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.parameter.name Short description Name as assigned by the client or server 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. Comments The names are assigned at the discretion of the server. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value[x]		0..1		There are no (further) constraints on this element Element id ValueSet.expansion.parameter.value[x] Short description Value of the named parameter Definition The value of the parameter. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
valueString			string	There are no (further) constraints on this element Data type string
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueInteger			integer	There are no (further) constraints on this element Data type integer
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
valueUri			uri	There are no (further) constraints on this element Data type uri
valueCode			code	There are no (further) constraints on this element Data type code
valueDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
property		0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion.property Short description Additional information supplied about each concept Definition A property defines an additional slot through which additional information can be provided about a concept. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.property.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.property.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.property.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
code		1..1	code	There are no (further) constraints on this element Element id ValueSet.expansion.property.code Short description Identifies the property on the concepts, and when referred to in operations Definition A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
uri		0..1	uri	There are no (further) constraints on this element Element id ValueSet.expansion.property.uri Short description Formal identifier for the property Definition Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
contains	C	0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion.contains Short description Codes in the value set Definition The codes that are contained in the value set expansion. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-6: SHALL have a code or a display `code.exists() or display.exists()` vsd-9: SHALL have a code if not abstract `code.exists() or abstract = true` vsd-10: SHALL have a system if a code is present `code.empty() or system.exists()`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.contains.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
system	C	0..1	uri	There are no (further) constraints on this element Element id ValueSet.expansion.contains.system Short description System value for the code Definition An absolute URI which is the code system in which the code for this item in the expansion is defined. Data type uri Conditions The cardinality or value of this element may be affected by these constraints: vsd-10 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
abstract	C	0..1	boolean	There are no (further) constraints on this element Element id ValueSet.expansion.contains.abstract Short description If user cannot select this entry 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. 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 when missing If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts Data type boolean Conditions The cardinality or value of this element may be affected by these constraints: vsd-9 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
inactive		0..1	boolean	There are no (further) constraints on this element Element id ValueSet.expansion.contains.inactive Short description If concept is inactive in the code system 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). Comments This should only have a value if the concept is inactive. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
version		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.contains.version Short description Version in which this code/display is defined 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. Comments The exact value of the version string is specified by the system from which the code is derived. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
code	C	0..1	code	There are no (further) constraints on this element Element id ValueSet.expansion.contains.code Short description Code - if blank, this is not a selectable 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. Data type code Conditions The cardinality or value of this element may be affected by these constraints: vsd-6, vsd-9, vsd-10 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
display	C	0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.contains.display Short description User display for the concept Definition The recommended display for this item in the expansion. Data type string Conditions The cardinality or value of this element may be affected by these constraints: vsd-6 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
designation		0..*	see (designation)	There are no (further) constraints on this element Element id ValueSet.expansion.contains.designation Short description Additional representations for this item 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. Comments The designations provided must be based on the value set and code system definitions. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
property		0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property Short description Property value for the concept Definition A property value for this concept. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
code		1..1	code	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.code Short description Reference to ValueSet.expansion.property.code Definition A code that is a reference to ValueSet.expansion.property.code. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value[x]		1..1		There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.value[x] Short description Value of the property for this concept Definition The value of this property. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
valueCode			code	There are no (further) constraints on this element Data type code
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
valueString			string	There are no (further) constraints on this element Data type string
valueInteger			integer	There are no (further) constraints on this element Data type integer
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
subProperty		0..*	BackboneElement	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty Short description SubProperty value for the concept Definition A subproperty value for this concept. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
code		1..1	code	There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty.code Short description Reference to ValueSet.expansion.property.code Definition A code that is a reference to ValueSet.expansion.property.code. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
value[x]		1..1		There are no (further) constraints on this element Element id ValueSet.expansion.contains.property.subProperty.value[x] Short description Value of the subproperty for this concept Definition The value of this subproperty. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
valueCode			code	There are no (further) constraints on this element Data type code
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
valueString			string	There are no (further) constraints on this element Data type string
valueInteger			integer	There are no (further) constraints on this element Data type integer
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
contains		0..*	see (contains)	There are no (further) constraints on this element Element id ValueSet.expansion.contains.contains Short description Codes contained under this entry Definition Other codes and entries contained under this entry in the hierarchy. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
scope		0..1	BackboneElement	There are no (further) constraints on this element Element id ValueSet.scope Short description Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description Definition Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id ValueSet.scope.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.scope.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id ValueSet.scope.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
inclusionCriteria		0..1	string	There are no (further) constraints on this element Element id ValueSet.scope.inclusionCriteria Short description Criteria describing which concepts or codes should be included and why Definition Criteria describing which concepts or codes should be included and why. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
exclusionCriteria		0..1	string	There are no (further) constraints on this element Element id ValueSet.scope.exclusionCriteria Short description Criteria describing which concepts or codes should be excluded and why Definition Criteria describing which concepts or codes should be excluded and why. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A

ValueSet
Short	A set of codes drawn from one or more code systems
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.
Cardinality	0..*
Constraints	cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation `name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`
Mappings	w5: conformance.behavior,conformance.terminology rim: N/A
ValueSet.id
Short	Logical id of this artifact
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0..1
Type	id
Must Support	True
Summary	True
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
Short	Metadata about the resource
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.
Cardinality	0..1
Type	Meta
Summary	True
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.implicitRules
Short	A set of rules under which this content was created
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.
Cardinality	0..1
Type	uri
Modifier	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.language
Short	Language of the resource content
Definition	The base language in which the resource is written.
Cardinality	0..1
Type	code
Binding	IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter)
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).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.text
Short	Text summary of the resource, for human interpretation
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.
Cardinality	0..1
Type	Narrative
Alias	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.
Conditions	The cardinality or value of this element may be affected by these constraints: dom-6
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
ValueSet.contained
Short	Contained, inline Resources
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.
Cardinality	0..*
Type	Resource
Alias	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.
Conditions	The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings	rim: N/A
ValueSet.extension
Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.modifierExtension
Short	Extensions that cannot be ignored
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.url
Short	Canonical identifier for this value set, represented as a URI (globally unique)
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.
Cardinality	0..1
Type	uri
Must Support	True
Summary	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.
Constraints	cnl-1: URL should not contain \| or # - these characters make processing canonical references problematic `exists() implies matches('^[^\|# ]+$')` ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier rim: N/A
ValueSet.identifier
Short	Additional identifier for the value set (business 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.
Cardinality	0..*
Type	Identifier
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier objimpl: no-gen-base
ValueSet.version
Short	Business version of the value set
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.
Cardinality	0..1
Type	string
Must Support	True
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.version
ValueSet.versionAlgorithm[x]
Short	How to compare versions
Definition	Indicates the mechanism used to compare versions to determine which ValueSet is more current.
Cardinality	0..1
Type	string, Coding
Binding	VersionAlgorithm (extensible)
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.name
Short	Name for this value set (computer friendly)
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.
Cardinality	0..1
Type	string
Must Support	True
Summary	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.
Conditions	The cardinality or value of this element may be affected by these constraints: cnl-0
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.title
Short	Name for this value set (human friendly)
Definition	A short, descriptive, user-friendly title for the value set.
Cardinality	0..1
Type	string
Summary	True
Comments	This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.status
Short	draft \| active \| retired \| unknown
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.
Cardinality	1..1
Type	code
Binding	The lifecycle status of an artifact. PublicationStatus (required)
Must Support	True
Modifier	True
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status
ValueSet.experimental
Short	For testing purposes, not real usage
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.
Cardinality	0..1
Type	boolean
Summary	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 when missing	If absent, this resource is treated as though it is not experimental.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
ValueSet.date
Short	Date last changed
Definition	The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised.
Cardinality	0..1
Type	dateTime
Must Support	True
Summary	True
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.recorded rim: N/A
ValueSet.publisher
Short	Name of the publisher/steward (organization or individual)
Definition	The name of the organization or individual responsible for the release and ongoing maintenance of the value set.
Cardinality	0..1
Type	string
Must Support	True
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.witness
ValueSet.contact
Short	Contact details for the publisher
Definition	Contact details to assist a user in finding and communicating with the publisher.
Cardinality	0..*
Type	ContactDetail
Summary	True
Comments	May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.description
Short	Natural language description of the value set
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.
Cardinality	0..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).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.useContext
Short	The context that the content is intended to support
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.
Cardinality	0..*
Type	UsageContext
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.jurisdiction
Short	Intended jurisdiction for value set (if applicable)
Definition	A legal or geographic region in which the value set is intended to be used.
Cardinality	0..*
Type	CodeableConcept
Binding	Countries and regions within which this artifact is targeted for use. JurisdictionValueSet (extensible)
Summary	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.)
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.immutable
Short	Indicates whether or not any change to the content logical definition may occur
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.
Cardinality	0..1
Type	boolean
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.purpose
Short	Why this value set is defined
Definition	Explanation of why this value set is needed and why it has been designed as it has.
Cardinality	0..1
Type	markdown
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.why[x] objimpl: no-gen-base
ValueSet.copyright
Short	Use and/or publishing restrictions
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.
Cardinality	0..1
Type	markdown
Alias	License, Restrictions
Requirements	Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	objimpl: no-gen-base
ValueSet.copyrightLabel
Short	Copyright holder and year(s)
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').
Cardinality	0..1
Type	string
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.approvalDate
Short	When the ValueSet was approved by publisher
Definition	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	objimpl: no-gen-base
ValueSet.lastReviewDate
Short	When the ValueSet was last reviewed by the publisher
Definition	The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	objimpl: no-gen-base
ValueSet.effectivePeriod
Short	When the ValueSet is expected to be used
Definition	The period during which the ValueSet content was or is planned to be in active use.
Cardinality	0..1
Type	Period
Summary	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	objimpl: no-gen-base
ValueSet.topic
Short	E.g. Education, Treatment, Assessment, etc
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.
Cardinality	0..*
Type	CodeableConcept
Binding	DefinitionTopic (example)
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)
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.author
Short	Who authored the ValueSet
Definition	An individiual or organization primarily involved in the creation and maintenance of the ValueSet.
Cardinality	0..*
Type	ContactDetail
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.editor
Short	Who edited the ValueSet
Definition	An individual or organization primarily responsible for internal coherence of the ValueSet.
Cardinality	0..*
Type	ContactDetail
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.reviewer
Short	Who reviewed the ValueSet
Definition	An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.
Cardinality	0..*
Type	ContactDetail
Comments	See guidance around (not) making local changes to elements here.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.endorser
Short	Who endorsed the ValueSet
Definition	An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.
Cardinality	0..*
Type	ContactDetail
Comments	See guidance around (not) making local changes to elements here.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.relatedArtifact
Short	Additional documentation, citations, etc
Definition	Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose
Short	Content logical definition of the value set (CLD)
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).
Cardinality	0..1
Type	BackboneElement
Must Support	True
Alias	Content Logical Definition, CLD
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.compose.lockedDate
Short	Fixed date for references with no specified version (transitive)
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.
Cardinality	0..1
Type	date
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.init
ValueSet.compose.inactive
Short	Whether inactive codes are in the value set
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).
Cardinality	0..1
Type	boolean
Summary	True
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).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.include
Short	Include one or more codes from a code system or other value set(s)
Definition	Include one or more codes from a code system or other value set(s).
Cardinality	1..*
Type	BackboneElement
Must Support	True
Summary	True
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'.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-1: A value set include/exclude SHALL have a value set or a system `valueSet.exists() or system.exists()` vsd-2: A value set with concepts or filters SHALL include a system `(concept.exists() or filter.exists()) implies system.exists()` vsd-3: Cannot have both concept and filter `concept.empty() or filter.empty()`
Mappings	rim: N/A
ValueSet.compose.include.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.include.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.compose.include.system
Short	The system the codes come from
Definition	An absolute URI which is the code system from which the selected codes come from.
Cardinality	0..1
Type	uri
Must Support	True
Summary	True
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.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.version
Short	Specific version of the code system referred to
Definition	The version of the code system that the codes are selected from, or the special version '*' for all versions.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.concept
Short	A concept defined in the system
Definition	Specifies a concept to be included or excluded.
Cardinality	0..*
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.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-3
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.concept.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.include.concept.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value)
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.concept.extension:definition
Short	A definition for this code
Definition	A definition that describes the meaning of this code when used as part of this value set.
Cardinality	0..1
Type	Extension(string)
Must Support	True
Alias	extensions, user content
Comments	This is provided for when the source code system doesn't actually provide a definition (there are many such). Providing an definition for a code SHOULD NOT be done where the underlying code system provides a definition.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.concept.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.compose.include.concept.code
Short	Code or expression from system
Definition	Specifies a code for the concept to be included or excluded.
Cardinality	1..1
Type	code
Must Support	True
Comments	Expressions are allowed if defined by the underlying code system.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.concept.display
Short	Text to display for this code for this value set in this valueset
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.
Cardinality	0..1
Type	string
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.concept.designation
Short	Additional representations for this concept
Definition	Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
Cardinality	0..*
Type	BackboneElement
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present `additionalUse.exists() implies use.exists()`
ValueSet.compose.include.concept.designation.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.include.concept.designation.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.concept.designation.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.compose.include.concept.designation.language
Short	Human language of the designation
Definition	The language this designation is defined for.
Cardinality	0..1
Type	code
Binding	IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter)
Comments	In the absence of a language, the resource language applies.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.include.concept.designation.use
Short	Types of uses of designations
Definition	A code that represents types of uses of designations.
Cardinality	0..1
Type	Coding
Binding	Details of how a designation would be used. DesignationUse (extensible)
Must Support	True
Comments	If no use is provided, the designation can be assumed to be suitable for general display to a human user.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-11
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.include.concept.designation.use.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	id
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.include.concept.designation.use.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.concept.designation.use.system
Short	Identity of the terminology system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	0..1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
ValueSet.compose.include.concept.designation.use.version
Short	Version of the system - if relevant
Definition	The version of the code system which was used when choosing this code. 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.
Cardinality	0..1
Type	string
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
ValueSet.compose.include.concept.designation.use.code
Short	Symbol in syntax defined by the system
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	0..1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
ValueSet.compose.include.concept.designation.use.display
Short	Representation defined by the system
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
ValueSet.compose.include.concept.designation.use.userSelected
Short	If this coding was chosen directly by the user
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0..1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ValueSet.compose.include.concept.designation.additionalUse
Short	Additional ways how this designation would be used
Definition	Additional codes that detail how this designation would be used, if there is more than one use.
Cardinality	0..*
Type	Coding
Binding	Details of how a designation would be used. DesignationUse (extensible)
Comments	This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-11
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.include.concept.designation.value
Short	The text value for this designation
Definition	The text value for this designation.
Cardinality	1..1
Type	string
Must Support	True
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.compose.include.filter
Short	Select codes/concepts by their properties (including relationships)
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.
Cardinality	0..*
Type	BackboneElement
Summary	True
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.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-2, vsd-3
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.filter.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.compose.include.filter.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.compose.include.filter.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.compose.include.filter.property
Short	A property/filter defined by the code system
Definition	A code that identifies a property or a filter defined in the code system.
Cardinality	1..1
Type	code
Summary	True
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.filter.op
Short	= \| is-a \| descendent-of \| is-not-a \| regex \| in \| not-in \| generalizes \| child-of \| descendent-leaf \| exists
Definition	The kind of operation to perform as a part of the filter criteria.
Cardinality	1..1
Type	code
Binding	The kind of operation to perform as a part of a property based filter. FilterOperator (required)
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.filter.value
Short	Code from the system, or regex criteria, or boolean value for exists
Definition	The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.
Cardinality	1..1
Type	string
Summary	True
Comments	Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.valueSet
Short	Select the contents included in this value set
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.
Cardinality	0..*
Type	canonical(ValueSet)
Summary	True
Comments	The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, 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.
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.include.copyright
Short	A copyright statement for the specific code system included in the value set
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).
Cardinality	0..1
Type	string
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.exclude
Short	Explicitly exclude codes from a code system or other value sets
Definition	Exclude one or more codes from the value set based on code system filters and/or other value sets.
Cardinality	0..*
Type	see (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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.compose.property
Short	Property to return if client doesn't override
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.
Cardinality	0..*
Type	string
Comments	Note that property names can clash, so using a URI is recommended.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion
Short	Used when the value set is "expanded"
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.identifier
Short	Identifies the value set expansion (business 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.
Cardinality	0..1
Type	uri
Comments	Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.next
Short	Opaque urls for paging through expansion results
Definition	As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.timestamp
Short	Time ValueSet expansion happened
Definition	The time at which the expansion was produced by the expanding system.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.total
Short	Total number of codes in the expansion
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.
Cardinality	0..1
Type	integer
Comments	Paging only applies to flat expansions.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.offset
Short	Offset at which this resource starts
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.
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 when missing	Paging is not being used
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.parameter
Short	Parameter that controlled the expansion process
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.
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).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.parameter.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.parameter.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.parameter.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.parameter.name
Short	Name as assigned by the client or server
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.
Cardinality	1..1
Type	string
Comments	The names are assigned at the discretion of the server.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.parameter.value[x]
Short	Value of the named parameter
Definition	The value of the parameter.
Cardinality	0..1
Type	string, boolean, integer, decimal, uri, code, dateTime
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.property
Short	Additional information supplied about each concept
Definition	A property defines an additional slot through which additional information can be provided about a concept.
Cardinality	0..*
Type	BackboneElement
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.property.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.property.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.property.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.property.code
Short	Identifies the property on the concepts, and when referred to in operations
Definition	A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.
Cardinality	1..1
Type	code
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.property.uri
Short	Formal identifier for the property
Definition	Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.
Cardinality	0..1
Type	uri
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains
Short	Codes in the value set
Definition	The codes that are contained in the value set expansion.
Cardinality	0..*
Type	BackboneElement
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` vsd-6: SHALL have a code or a display `code.exists() or display.exists()` vsd-9: SHALL have a code if not abstract `code.exists() or abstract = true` vsd-10: SHALL have a system if a code is present `code.empty() or system.exists()`
ValueSet.expansion.contains.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.contains.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.contains.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.contains.system
Short	System value for the code
Definition	An absolute URI which is the code system in which the code for this item in the expansion is defined.
Cardinality	0..1
Type	uri
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-10
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.abstract
Short	If user cannot select this entry
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.
Cardinality	0..1
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 when missing	If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-9
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.inactive
Short	If concept is inactive in the code system
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).
Cardinality	0..1
Type	boolean
Comments	This should only have a value if the concept is inactive.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.version
Short	Version in which this code/display is defined
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.
Cardinality	0..1
Type	string
Comments	The exact value of the version string is specified by the system from which the code is derived.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.code
Short	Code - if blank, this is not a selectable 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.
Cardinality	0..1
Type	code
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-6, vsd-9, vsd-10
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.display
Short	User display for the concept
Definition	The recommended display for this item in the expansion.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: vsd-6
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.designation
Short	Additional representations for this item
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.
Cardinality	0..*
Type	see (designation)
Comments	The designations provided must be based on the value set and code system definitions.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property
Short	Property value for the concept
Definition	A property value for this concept.
Cardinality	0..*
Type	BackboneElement
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.contains.property.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.contains.property.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.contains.property.code
Short	Reference to ValueSet.expansion.property.code
Definition	A code that is a reference to ValueSet.expansion.property.code.
Cardinality	1..1
Type	code
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property.value[x]
Short	Value of the property for this concept
Definition	The value of this property.
Cardinality	1..1
Type	code, Coding, string, integer, boolean, dateTime, decimal
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property.subProperty
Short	SubProperty value for the concept
Definition	A subproperty value for this concept.
Cardinality	0..*
Type	BackboneElement
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property.subProperty.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.expansion.contains.property.subProperty.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.expansion.contains.property.subProperty.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.expansion.contains.property.subProperty.code
Short	Reference to ValueSet.expansion.property.code
Definition	A code that is a reference to ValueSet.expansion.property.code.
Cardinality	1..1
Type	code
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.property.subProperty.value[x]
Short	Value of the subproperty for this concept
Definition	The value of this subproperty.
Cardinality	1..1
Type	code, Coding, string, integer, boolean, dateTime, decimal
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.expansion.contains.contains
Short	Codes contained under this entry
Definition	Other codes and entries contained under this entry in the hierarchy.
Cardinality	0..*
Type	see (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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.scope
Short	Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
Definition	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
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
ValueSet.scope.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
ValueSet.scope.extension
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
ValueSet.scope.modifierExtension
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
ValueSet.scope.inclusionCriteria
Short	Criteria describing which concepts or codes should be included and why
Definition	Criteria describing which concepts or codes should be included and why.
Cardinality	0..1
Type	string
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
ValueSet.scope.exclusionCriteria
Short	Criteria describing which concepts or codes should be excluded and why
Definition	Criteria describing which concepts or codes should be excluded and why.
Cardinality	0..1
Type	string
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A

<id value="HVOValueSet" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-implements">
<valueUri value="http://hl7.org/fhir/StructureDefinition/MetadataResource" />
</extension>
<url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOValueSet" />
<version value="0.1.0" />
<name value="HVOValueSet" />
<status value="draft" />
<description value="A collection of codes from one or more code systems." />
<fhirVersion value="5.0.0" />
<kind value="resource" />
<abstract value="false" />
<type value="ValueSet" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/ValueSet" />
<derivation value="constraint" />
<differential>
<element id="ValueSet.id">
<path value="ValueSet.id" />
<mustSupport value="true" />
</element>
<element id="ValueSet.url">
<path value="ValueSet.url" />
<mustSupport value="true" />
</element>
<element id="ValueSet.version">
<path value="ValueSet.version" />
<mustSupport value="true" />
</element>
<element id="ValueSet.name">
<path value="ValueSet.name" />
<mustSupport value="true" />
</element>
<element id="ValueSet.status">
<path value="ValueSet.status" />
<mustSupport value="true" />
</element>
<element id="ValueSet.date">
<path value="ValueSet.date" />
<mustSupport value="true" />
</element>
<element id="ValueSet.publisher">
<path value="ValueSet.publisher" />
<mustSupport value="true" />
</element>
<element id="ValueSet.description">
<path value="ValueSet.description" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose">
<path value="ValueSet.compose" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include">
<path value="ValueSet.compose.include" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.system">
<path value="ValueSet.compose.include.system" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.version">
<path value="ValueSet.compose.include.version" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.extension">
<path value="ValueSet.compose.include.concept.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="ValueSet.compose.include.concept.extension:definition">
<path value="ValueSet.compose.include.concept.extension" />
<sliceName value="definition" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition" />
</type>
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.code">
<path value="ValueSet.compose.include.concept.code" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.display">
<path value="ValueSet.compose.include.concept.display" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation">
<path value="ValueSet.compose.include.concept.designation" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation.use">
<path value="ValueSet.compose.include.concept.designation.use" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation.use.system">
<path value="ValueSet.compose.include.concept.designation.use.system" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation.use.code">
<path value="ValueSet.compose.include.concept.designation.use.code" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation.use.display">
<path value="ValueSet.compose.include.concept.designation.use.display" />
<mustSupport value="true" />
</element>
<element id="ValueSet.compose.include.concept.designation.value">
<path value="ValueSet.compose.include.concept.designation.value" />
<mustSupport value="true" />
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "HVOValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueUri": "http://hl7.org/fhir/StructureDefinition/MetadataResource"
}
],
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOValueSet",
"version": "0.1.0",
"name": "HVOValueSet",
"status": "draft",
"description": "A collection of codes from one or more code systems.",
"fhirVersion": "5.0.0",
"kind": "resource",
"abstract": false,
"type": "ValueSet",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ValueSet",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "ValueSet.id",
"path": "ValueSet.id",
"mustSupport": true
},
{
"id": "ValueSet.url",
"path": "ValueSet.url",
"mustSupport": true
},
{
"id": "ValueSet.version",
"path": "ValueSet.version",
"mustSupport": true
},
{
"id": "ValueSet.name",
"path": "ValueSet.name",
"mustSupport": true
},
{
"id": "ValueSet.status",
"path": "ValueSet.status",
"mustSupport": true
},
{
"id": "ValueSet.date",
"path": "ValueSet.date",
"mustSupport": true
},
{
"id": "ValueSet.publisher",
"path": "ValueSet.publisher",
"mustSupport": true
},
{
"id": "ValueSet.description",
"path": "ValueSet.description",
"mustSupport": true
},
{
"id": "ValueSet.compose",
"path": "ValueSet.compose",
"mustSupport": true
},
{
"id": "ValueSet.compose.include",
"path": "ValueSet.compose.include",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.system",
"path": "ValueSet.compose.include.system",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.version",
"path": "ValueSet.compose.include.version",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.extension",
"path": "ValueSet.compose.include.concept.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "ValueSet.compose.include.concept.extension:definition",
"path": "ValueSet.compose.include.concept.extension",
"sliceName": "definition",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/valueset-concept-definition"
]
}
],
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.code",
"path": "ValueSet.compose.include.concept.code",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.display",
"path": "ValueSet.compose.include.concept.display",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation",
"path": "ValueSet.compose.include.concept.designation",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation.use",
"path": "ValueSet.compose.include.concept.designation.use",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation.use.system",
"path": "ValueSet.compose.include.concept.designation.use.system",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation.use.code",
"path": "ValueSet.compose.include.concept.designation.use.code",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation.use.display",
"path": "ValueSet.compose.include.concept.designation.use.display",
"mustSupport": true
},
{
"id": "ValueSet.compose.include.concept.designation.value",
"path": "ValueSet.compose.include.concept.designation.value",
"mustSupport": true
}
]
}

}

Supported operations

HTTP methods

Operation	Supported	Comment
Search (GET, POST)	yes	Only GET
Insert (POST)	no
Update (PUT)	no
Delete (DEL)	no
Operation (GET, POST)	yes	Only GET

Query operations

Supported Queries

GET .../ValueSet returns a Bundle of all ValueSets.
GET .../ValueSet/[LogicalId] returns the ValueSet with the given logical ID.

Search parameters

Parameter	Description	Comment
ValueSet/[id]	A read based on the ID of an ValueSet.

Other operations

Validate code

Validate that a coded value is in the set of codes allowed by a value set. This is a standard operation in FHIR.

This operation does NOT change content

Operation name	HTTP verbs	Link
$validate-code	GET	https://hl7.org/fhir/R4/valueset-operation-validate-code.html

Parameters (In)

Name	Cardinality	Type	Documentation
id	1..1	string	The id of the ValueSet
code	1..1	code	The code that is to be validated
date	0..1	dateTime	The date for which the validation should be checked
valueSetVersion	0..1	string	The identifier that is used to identify a specific version of the value set to be used when validating the code

Return Values (Out)

Name	Cardinality	Type	Documentation
result	1..1	boolean	True if the concept details supplied are valid

Invocations

URL: [base]/[id]/ValueSet/$validate-code

The following example checks whether the code ADMIN is included in the hvo-contact-purpose value set: GET [base]/hvo-contact-purpose/ValueSet/$validate-code?code=ADMIN