Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

## Resource Profile: USPublicHealthSupplementalValueSet - Detailed Descriptions

Active as of 2023-06-08

Definitions for the us-ph-supplemental-valueset resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. ValueSet
2. ValueSet.useContext
Slicing | This element introduces a set of slices on ValueSet.useContext. The slices are and ClosedOpen, and can be differentiated using the following discriminators: @
3. ValueSet.useContext:reportingContext
SliceName | reportingContext
Control | 1..1
Must Support | true
4. ValueSet.useContext:reportingContext.code
Control | 1..1
Must Support | true
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context-type"/> <code value="reporting"/> </valueCoding>
5. ValueSet.useContext:reportingContext.value[x]
Definition | The US Public Health use context of the value set.
Control | 1..1
Type | CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context"/> <code value="supplemental"/> </coding> </valueCodeableConcept>

Guidance on how to interpret the contents of this table can be found here.

1. ValueSet
Definition | A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements. 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.
Control | 10..1*
Summary | false
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. ValueSet.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is 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 it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. ValueSet.extension
Definition | An Extension 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 manageable, 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.
Control | 20..*
Type | Extension
Must Support | true
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
Slicing | This element introduces a set of slices on ValueSet.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. ValueSet.extension:extensionValueSetSteward
SliceName | extensionValueSetSteward
Definition | The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(steward) (Extension Type: ContactDetail)
Must Support | true
Comments | The information included should include contact information.
Invariants | Defined on this element 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())
5. ValueSet.extension:extensionValueSetAuthor
SliceName | extensionValueSetAuthor
Definition | The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(author) (Extension Type: ContactDetail)
Must Support | true
Comments | This can be any combination of groups or individuals. When known and actively maintained, this should be populated. The information included about the Author may include contact information.
Invariants | Defined on this element 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())
6. ValueSet.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
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. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
7. ValueSet.url
Definition | An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which 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.
Control | 10..1
Type | uri
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. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ValueSet.identifier
Definition | The identifier of the value set. 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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. ValueSet.version
Definition | The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 10..1
Type | string
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].
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. ValueSet.name
Definition | The name of the value set. 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.
Control | 10..1 This element is affected by the following invariants: inv-0
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. ValueSet.title
Definition | The title of the value set. A short, descriptive, user-friendly title for the value set.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. ValueSet.status
Definition | The value set definition version. 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.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact.
Type | code
Is Modifier | true
Must Support | true
Summary | true
Comments | Allows filtering of value sets that are appropriate for use versus not.See also the valueset-workflowStatus extension for additional status information related to the editorial process. Allows filtering of value sets that are appropriate for use versus not.See also the valueset-workflowStatus extension for additional status information related to the editorial process.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. ValueSet.experimental
Definition | A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Control | 10..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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. ValueSet.publisher
Definition | The name of the organization or individual that published the value set.
Control | 10..1
Type | string
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the value set. May also allow for contact.
Alternate Names | steward
Comments | Usually an organization but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. ValueSet.description
Definition | The value set definition (depending on source, could be a concatenation of the value set fields Clinical Focus, Data Element Scope, Inclusion Criteria, Exclusion Criteria, and Note). 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.
Control | 10..1
Type | markdown
Must Support | true
Summary | false
Alternate Names | Scope, Purpose, scope
Comments | This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the value set is presumed to be the predominant language in the place the value set was created).The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. ValueSet.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.
Control | 10..*
Type | UsageContext
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on ValueSet.useContext. The slices are unordered and Closed, and can be differentiated using the following discriminators: pattern @ code
17. ValueSet.useContext:reportingContext
SliceName | reportingContext
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.
Control | 10..1*
Type | UsageContext
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. ValueSet.useContext:reportingContext.code
Definition | A code that identifies the type of context being specified by this usage context.
Control | 1..1
Binding | The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context.
Type | Coding
Must Support | true
Summary | true
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context-type"/> <code value="reporting"/> </valueCoding>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. ValueSet.useContext:reportingContext.value[x]
Definition | The US Public Health use context of the value set. A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Control | 1..1
Binding | For example codes, see Context of Use ValueSet A code that defines the specific value for the context being specified.
Type | Choice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context"/> <code value="supplemental"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. ValueSet
Definition | A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.
Control | 1..1
Summary | false
2. ValueSet.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. ValueSet.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. ValueSet.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is 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 it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. ValueSet.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. ValueSet.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. ValueSet.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. ValueSet.extension
Definition | An Extension
Control | 2..*
Type | Extension
Must Support | true
Summary | false
Invariants | Defined on this element 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())
Slicing | This element introduces a set of slices on ValueSet.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. ValueSet.extension:extensionValueSetSteward
SliceName | extensionValueSetSteward
Definition | The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(steward) (Extension Type: ContactDetail)
Must Support | true
Comments | The information included should include contact information.
Invariants | Defined on this element 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())
10. ValueSet.extension:extensionValueSetAuthor
SliceName | extensionValueSetAuthor
Definition | The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(author) (Extension Type: ContactDetail)
Must Support | true
Comments | This can be any combination of groups or individuals. When known and actively maintained, this should be populated. The information included about the Author may include contact information.
Invariants | Defined on this element 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())
11. ValueSet.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
12. ValueSet.url
Definition | An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which 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.
Control | 1..1
Type | uri
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. ValueSet.identifier
Definition | The identifier of the value set.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. ValueSet.version
Definition | The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 1..1
Type | string
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].
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. ValueSet.name
Definition | The name of the value set.
Control | 1..1 This element is affected by the following invariants: inv-0
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. ValueSet.title
Definition | The title of the value set.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. ValueSet.status
Definition | The value set definition version.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact
Type | code
Is Modifier | true
Must Support | true
Summary | true
Comments | Allows filtering of value sets that are appropriate for use versus not.See also the valueset-workflowStatus extension for additional status information related to the editorial process.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. ValueSet.experimental
Definition | A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Control | 1..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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. ValueSet.date
Definition | The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
Control | 0..1
Type | dateTime
Summary | true
Alternate Names | Revision Date
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. ValueSet.publisher
Definition | The name of the organization or individual that published the value set.
Control | 1..1
Type | string
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the value set. May also allow for contact.
Alternate Names | steward
Comments | Usually an organization but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. ValueSet.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Control | 0..*
Type | ContactDetail
Summary | true
Comments | May be a web site, an email address, a telephone number, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. ValueSet.description
Definition | The value set definition (depending on source, could be a concatenation of the value set fields Clinical Focus, Data Element Scope, Inclusion Criteria, Exclusion Criteria, and Note).
Control | 1..1
Type | markdown
Must Support | true
Summary | false
Alternate Names | Scope, Purpose, scope
Comments | This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the value set is presumed to be the predominant language in the place the value set was created).The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. ValueSet.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.
Control | 1..*
Type | UsageContext
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on ValueSet.useContext. The slices are unordered and Closed, and can be differentiated using the following discriminators: pattern @ code
24. ValueSet.useContext:reportingContext
SliceName | reportingContext
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.
Control | 1..1
Type | UsageContext
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. ValueSet.useContext:reportingContext.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
26. ValueSet.useContext:reportingContext.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
Slicing | This element introduces a set of slices on ValueSet.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
27. ValueSet.useContext:reportingContext.code
Definition | A code that identifies the type of context being specified by this usage context.
Control | 1..1
Binding | The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
Type | Coding
Must Support | true
Summary | true
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context-type"/> <code value="reporting"/> </valueCoding>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. ValueSet.useContext:reportingContext.value[x]
Definition | The US Public Health use context of the value set.
Control | 1..1
Binding | For example codes, see Context of Use ValueSet A code that defines the specific value for the context being specified
Type | CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-usage-context"/> <code value="supplemental"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. ValueSet.jurisdiction
Definition | A legal or geographic region in which the value set is intended to be used.
Control | 0..*
Binding | The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use
Type | CodeableConcept
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. ValueSet.immutable
Definition | If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. ValueSet.purpose
Definition | Explanation of why this value set is needed and why it has been designed as it has.
Control | 0..1
Type | markdown
Summary | false
Comments | This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. ValueSet.copyright
Definition | A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
Control | 0..1
Type | markdown
Summary | false
Requirements | Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.
Alternate Names | License, Restrictions
Comments | nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. ValueSet.compose
Definition | A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
Control | 0..1
Type | BackboneElement
Summary | false
Alternate Names | Content Logical Definition, CLD
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. ValueSet.compose.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
35. ValueSet.compose.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
36. ValueSet.compose.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
37. ValueSet.compose.lockedDate
Definition | The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. ValueSet.compose.inactive
Definition | Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
Control | 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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ValueSet.compose.include
Definition | Include one or more codes from a code system or other value set(s).
Control | 1..*
Type | BackboneElement
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'.
Invariants | Defined on this element 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())
40. ValueSet.compose.include.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
41. ValueSet.compose.include.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
42. ValueSet.compose.include.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
43. ValueSet.compose.include.system
Definition | An absolute URI which is the code system from which the selected codes come from.
Control | 0..1 This element is affected by the following invariants: vsd-1, vsd-2
Type | uri
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. ValueSet.compose.include.version
Definition | The version of the code system that the codes are selected from, or the special version '*' for all versions.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. ValueSet.compose.include.concept
Definition | Specifies a concept to be included or excluded.
Control | 0..* This element is affected by the following invariants: vsd-3
Type | BackboneElement
Summary | false
Comments | The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. ValueSet.compose.include.concept.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
47. ValueSet.compose.include.concept.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
48. ValueSet.compose.include.concept.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
49. ValueSet.compose.include.concept.code
Definition | Specifies a code for the concept to be included or excluded.
Control | 1..1
Type | code
Summary | false
Comments | Expressions are allowed if defined by the underlying code system.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. ValueSet.compose.include.concept.display
Definition | The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
Control | 0..1
Type | string
Summary | false
Comments | The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. ValueSet.compose.include.concept.designation
Definition | Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
Control | 0..*
Type | BackboneElement
Summary | false
Comments | Concepts have both a `display` and an array of `designation`. The display is equivalent to a special designation with an implied `designation.use` of "primary code" and a language equal to the Resource Language.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. ValueSet.compose.include.concept.designation.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
53. ValueSet.compose.include.concept.designation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
54. ValueSet.compose.include.concept.designation.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
55. ValueSet.compose.include.concept.designation.language
Definition | The language this designation is defined for.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
Comments | In the absence of a language, the resource language applies.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. ValueSet.compose.include.concept.designation.use
Definition | A code that represents types of uses of designations.
Control | 0..1
Binding | The codes SHALL be taken from DesignationUse; other codes may be used where these codes are not suitable Details of how a designation would be used
Type | Coding
Summary | false
Comments | If no use is provided, the designation can be assumed to be suitable for general display to a human user.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. ValueSet.compose.include.concept.designation.value
Definition | The text value for this designation.
Control | 1..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. ValueSet.compose.include.filter
Definition | Select concepts by specify 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, they SHALL all be true.
Control | 0..* This element is affected by the following invariants: vsd-3
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. ValueSet.compose.include.filter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
60. ValueSet.compose.include.filter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
61. ValueSet.compose.include.filter.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
62. ValueSet.compose.include.filter.property
Definition | A code that identifies a property or a filter defined in the code system.
Control | 1..1
Type | code
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. ValueSet.compose.include.filter.op
Definition | The kind of operation to perform as a part of the filter criteria.
Control | 1..1
Binding | The codes SHALL be taken from FilterOperator The kind of operation to perform as a part of a property based filter
Type | code
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. ValueSet.compose.include.filter.value
Definition | The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (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'.
Control | 1..1
Type | string
Summary | true
Comments | Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. ValueSet.compose.include.valueSet
Definition | Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.
Control | 0..* This element is affected by the following invariants: vsd-1
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. ValueSet.compose.exclude
Definition | Exclude one or more codes from the value set based on code system filters and/or other value sets.
Control | 0..* This element is affected by the following invariants: vsd-2
Type | See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include
Summary | false
Comments | Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. ValueSet.expansion
Definition | A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
Control | 0..1
Type | BackboneElement
Summary | false
Comments | Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance. Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. ValueSet.expansion.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
69. ValueSet.expansion.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
70. ValueSet.expansion.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
71. ValueSet.expansion.identifier
Definition | An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | uri
Summary | false
Comments | Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. ValueSet.expansion.timestamp
Definition | The time at which the expansion was produced by the expanding system.
Control | 1..1
Type | dateTime
Summary | false
Comments | This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. ValueSet.expansion.total
Definition | The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
Control | 0..1
Type | integer
Summary | false
Comments | Paging only applies to flat expansions.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. ValueSet.expansion.offset
Definition | If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.
Control | 0..1
Type | integer
Summary | false
Comments | Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.
Meaning if Missing | Paging is not being used
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. ValueSet.expansion.parameter
Definition | A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
Control | 0..*
Type | BackboneElement
Summary | false
Comments | The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. ValueSet.expansion.parameter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
77. ValueSet.expansion.parameter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
78. ValueSet.expansion.parameter.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
79. ValueSet.expansion.parameter.name
Definition | Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.
Control | 1..1
Type | string
Summary | false
Comments | The names are assigned at the discretion of the server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. ValueSet.expansion.parameter.value[x]
Definition | The value of the parameter.
Control | 0..1
Type | Choice of: string, boolean, integer, decimal, uri, code, dateTime
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. ValueSet.expansion.contains
Definition | The codes that are contained in the value set expansion.
Control | 0..*
Type | BackboneElement
Summary | false
Invariants | Defined on this element 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: Must have a code if not abstract (: code.exists() or abstract = true) vsd-10: Must have a system if a code is present (: code.empty() or system.exists())
82. ValueSet.expansion.contains.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
83. ValueSet.expansion.contains.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
84. ValueSet.expansion.contains.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element 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())
85. ValueSet.expansion.contains.system
Definition | An absolute URI which is the code system in which the code for this item in the expansion is defined.
Control | 0..1
Type | uri
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. ValueSet.expansion.contains.abstract
Definition | If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
Control | 0..1
Type | boolean
Summary | false
Comments | This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.
Meaning if Missing | If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. ValueSet.expansion.contains.inactive
Definition | If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).
Control | 0..1
Type | boolean
Summary | false
Comments | This should only have a value if the concept is inactive.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. ValueSet.expansion.contains.version
Definition | The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Note | This is a business versionId, not a resource version id (see discussion)
Control | 0..1
Type | string
Summary | false
Comments | The exact value of the version string is specified by the system from which the code is derived.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. ValueSet.expansion.contains.code
Definition | The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
Control | 0..1 This element is affected by the following invariants: vsd-6
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. ValueSet.expansion.contains.display
Definition | The recommended display for this item in the expansion.
Control | 0..1 This element is affected by the following invariants: vsd-6
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
91. ValueSet.expansion.contains.designation
Definition | Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
Control | 0..*
Type | See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.compose.include.concept.designation
Summary | false
Comments | The designations provided must be based on the value set and code system definitions.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. ValueSet.expansion.contains.contains
Definition | Other codes and entries contained under this entry in the hierarchy.
Control | 0..*
Type | See ttp://hl7.org/fhir/StructureDefinition/ValueSet#ValueSet.expansion.contains
Summary | false
Comments | If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))