Page Status: updated 2023-09-05

ValueSet

Page index

Introduction

The ValueSet resource, shown in the profile NLLValueSet, represents a set of codes that is used in a specific context.

The codes in a value set are a combination of codes from one or many code systems. The value set can include all codes in a code system, or only a subset of the codes from the code system.

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

Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources

Overview

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlS Σ0..1uri
identifierΣ0..*Identifier
versionS Σ0..1string
nameS Σ I0..1string
titleS Σ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateS Σ0..1dateTime
publisherS Σ0..1string
contactΣ0..*ContactDetail
descriptionS0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
immutableΣ0..1boolean
purpose0..1markdown
copyright0..1markdown
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lockedDateΣ0..1date
inactiveΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
systemS Σ I0..1uri
versionS Σ0..1string
id0..1string
definitionS I0..1Extension(string)
modifierExtensionΣ ?! I0..*Extension
codeS1..1code
displayS0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
languageS0..1codeBinding
id0..1string
extensionI0..*Extension
systemS Σ0..1uriBinding
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
valueS1..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
propertyΣ1..1code
opΣ1..1codeBinding
valueΣ1..1string
valueSetΣ I0..*canonical(ValueSet)
excludeI0..*see (include)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..1uri
timestamp1..1dateTime
total0..1integer
offset0..1integer
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
name1..1string
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueDecimaldecimal
valueUriuri
valueCodecode
valueDateTimedateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
system0..1uri
abstract0..1boolean
inactive0..1boolean
version0..1string
codeI0..1code
displayI0..1string
designation0..*see (designation)
contains0..*see (contains)
ValueSet
DefinitionA 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](codesystem.html) definitions and their use in [coded elements](terminologies.html).
Cardinality0...*
Invariants
  • 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}')
Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
ValueSet.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Mappings
  • EHM: Värdemängds-id
ValueSet.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
ValueSet.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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.

Mappings
  • rim: N/A
ValueSet.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.url
DefinitionAn 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.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.url
  • w5: FiveWs.identifier
  • rim: N/A
ValueSet.identifier
DefinitionA 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.
Cardinality0...*
TypeIdentifier
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.identifier
  • w5: FiveWs.identifier
  • objimpl: no-gen-base
ValueSet.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.version
  • w5: FiveWs.version
  • EHM: Version
ValueSet.name
DefinitionA 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Tekniskt namn
ValueSet.title
DefinitionA short, descriptive, user-friendly title for the value set.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.title
  • EHM: Namn
ValueSet.status
DefinitionThe 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.
Cardinality1...1
Typecode
Binding

The lifecycle status of an artifact.

PublicationStatus (required)
Must SupportTrue
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.status
  • w5: FiveWs.status
  • EHM: Status
ValueSet.experimental
DefinitionA 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.
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.experimental
  • w5: FiveWs.class
ValueSet.date
DefinitionThe date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
AliasRevision 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.date
  • w5: FiveWs.recorded
  • rim: N/A
  • EHM: Revisionsdatum
ValueSet.publisher
DefinitionThe name of the organization or individual that published the value set.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.publisher
  • w5: FiveWs.witness
  • EHM: Utgivare
ValueSet.contact
DefinitionContact details to assist a user in finding and communicating with the publisher.
Cardinality0...*
TypeContactDetail
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.contact
ValueSet.description
DefinitionA 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.
Cardinality0...1
Typemarkdown
Must SupportTrue
AliasScope, Purpose
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.description
  • rim: N/A
  • EHM: Beskrivning
ValueSet.useContext
DefinitionThe 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.
Cardinality0...*
TypeUsageContext
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.useContext
ValueSet.jurisdiction
DefinitionA legal or geographic region in which the value set is intended to be used.
Cardinality0...*
TypeCodeableConcept
Binding

Countries and regions within which this artifact is targeted for use.

Jurisdiction ValueSet (extensible)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.jurisdiction
ValueSet.immutable
DefinitionIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.purpose
DefinitionExplanation of why this value set is needed and why it has been designed as it has.
Cardinality0...1
Typemarkdown
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.purpose
  • w5: FiveWs.why[x]
  • objimpl: no-gen-base
ValueSet.copyright
DefinitionA 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.
Cardinality0...1
Typemarkdown
AliasLicense, Restrictions
Requirements

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

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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.copyright
  • objimpl: no-gen-base
ValueSet.compose
DefinitionA 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).
Cardinality0...1
TypeBackboneElement
Must SupportTrue
AliasContent Logical Definition, CLD
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.compose.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.compose.lockedDate
DefinitionThe 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.
Cardinality0...1
Typedate
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
ValueSet.compose.inactive
DefinitionWhether 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).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.compose.include
DefinitionInclude one or more codes from a code system or other value set(s).
Cardinality1...*
TypeBackboneElement
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • vsd-1: A value set include/exclude SHALL have a value set or a system
    valueSet.exists() or system.exists()
  • vsd-2: A value set with concepts or filters SHALL include a system
    (concept.exists() or filter.exists()) implies system.exists()
  • vsd-3: Cannot have both concept and filter
    concept.empty() or filter.empty()
Mappings
  • rim: N/A
  • EHM: Kodsystem
ValueSet.compose.include.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.include.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.compose.include.system
DefinitionAn absolute URI which is the code system from which the selected codes come from.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • EHM: Kodsystem referens
ValueSet.compose.include.version
DefinitionThe version of the code system that the codes are selected from, or the special version '*' for all versions.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • EHM: Kodsystem version
ValueSet.compose.include.concept
DefinitionSpecifies a concept to be included or excluded.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • EHM: Koncept
ValueSet.compose.include.concept.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.include.concept.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.concept.extension:definition
DefinitionA definition that describes the meaning of this code when used as part of this value set.
Cardinality0...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
Comments

This is provided for when the source code system doesn't actually provide a definition (there are many such). Providing an definition for a code SHOULD NOT be done where the underlying code system provides a definition.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.concept.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.compose.include.concept.code
DefinitionSpecifies a code for the concept to be included or excluded.
Cardinality1...1
Typecode
Must SupportTrue
Comments

Expressions are allowed if defined by the underlying code system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • EHM: Kod
ValueSet.compose.include.concept.display
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • EHM: Term
ValueSet.compose.include.concept.designation
DefinitionAdditional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Ytterligare benämningar
ValueSet.compose.include.concept.designation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.include.concept.designation.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.concept.designation.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.compose.include.concept.designation.language
DefinitionThe language this designation is defined for.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Must SupportTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Språk
ValueSet.compose.include.concept.designation.use
DefinitionA code that represents types of uses of designations.
Cardinality0...1
TypeCoding
Binding

Details of how a designation would be used.

http://electronichealth.se/fhir/ValueSet/nll-snomed-designation-use (extensible)
Must SupportTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Alternativ benämningstyp
ValueSet.compose.include.concept.designation.use.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.include.concept.designation.use.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.concept.designation.use.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Bindinghttp://electronichealth.se/fhir/ValueSet/concept-discriminators (required)
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • EHM: Alternativ benämningssystemreferens
ValueSet.compose.include.concept.designation.use.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
ValueSet.compose.include.concept.designation.use.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • EHM: Alternativ benämningskod
ValueSet.compose.include.concept.designation.use.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • EHM: Alternativ benämningsterm
ValueSet.compose.include.concept.designation.use.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ValueSet.compose.include.concept.designation.value
DefinitionThe text value for this designation.
Cardinality1...1
Typestring
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Alternativ term
ValueSet.compose.include.filter
DefinitionSelect 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.
Cardinality0...*
TypeBackboneElement
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.compose.include.filter.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.compose.include.filter.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.compose.include.filter.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.compose.include.filter.property
DefinitionA code that identifies a property or a filter defined in the code system.
Cardinality1...1
Typecode
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.compose.include.filter.op
DefinitionThe kind of operation to perform as a part of the filter criteria.
Cardinality1...1
Typecode
Binding

The kind of operation to perform as a part of a property based filter.

FilterOperator (required)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.compose.include.filter.value
DefinitionThe 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'.
Cardinality1...1
Typestring
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.compose.include.valueSet
DefinitionSelects 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.
Cardinality0...*
Typecanonical(ValueSet)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.compose.exclude
DefinitionExclude one or more codes from the value set based on code system filters and/or other value sets.
Cardinality0...*
Typesee (include)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ValueSet.expansion
DefinitionA 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.
Cardinality0...1
TypeBackboneElement
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.expansion.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.expansion.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.expansion.identifier
DefinitionAn 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.
Cardinality0...1
Typeuri
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.timestamp
DefinitionThe time at which the expansion was produced by the expanding system.
Cardinality1...1
TypedateTime
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.total
DefinitionThe 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.
Cardinality0...1
Typeinteger
Comments

Paging only applies to flat expansions.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.offset
DefinitionIf 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.
Cardinality0...1
Typeinteger
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.parameter
DefinitionA 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.
Cardinality0...*
TypeBackboneElement
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.expansion.parameter.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.expansion.parameter.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.expansion.parameter.name
DefinitionName 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.
Cardinality1...1
Typestring
Comments

The names are assigned at the discretion of the server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.parameter.value[x]
DefinitionThe value of the parameter.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains
DefinitionThe codes that are contained in the value set expansion.
Cardinality0...*
TypeBackboneElement
Invariants
  • 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()
ValueSet.expansion.contains.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ValueSet.expansion.contains.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ValueSet.expansion.contains.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ValueSet.expansion.contains.system
DefinitionAn absolute URI which is the code system in which the code for this item in the expansion is defined.
Cardinality0...1
Typeuri
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.abstract
DefinitionIf true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
Cardinality0...1
Typeboolean
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.inactive
DefinitionIf 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).
Cardinality0...1
Typeboolean
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.version
DefinitionThe 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.
Cardinality0...1
Typestring
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.code
DefinitionThe 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.
Cardinality0...1
Typecode
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.display
DefinitionThe recommended display for this item in the expansion.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.designation
DefinitionAdditional 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.
Cardinality0...*
Typesee (designation)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ValueSet.expansion.contains.contains
DefinitionOther codes and entries contained under this entry in the hierarchy.
Cardinality0...*
Typesee (contains)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://electronichealth.se/fhir/StructureDefinition/NLLValueSet" />
    <version value="1.0.0" />
    <name value="NLLValueSet" />
    <status value="active" />
    <date value="2022-02-10" />
    <publisher value="Swedish eHealth Agency" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="EHM" />
        <name value="E-h&#228;lsomyndigheten concept" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="ValueSet" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ValueSet" />
    <derivation value="constraint" />
    <differential>
        <element id="ValueSet.id">
            <path value="ValueSet.id" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="V&#228;rdem&#228;ngds-id" />
            </mapping>
        </element>
        <element id="ValueSet.url">
            <path value="ValueSet.url" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.version">
            <path value="ValueSet.version" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Version" />
            </mapping>
        </element>
        <element id="ValueSet.name">
            <path value="ValueSet.name" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Tekniskt namn" />
            </mapping>
        </element>
        <element id="ValueSet.title">
            <path value="ValueSet.title" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Namn" />
            </mapping>
        </element>
        <element id="ValueSet.status">
            <path value="ValueSet.status" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Status" />
            </mapping>
        </element>
        <element id="ValueSet.date">
            <path value="ValueSet.date" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Revisionsdatum" />
            </mapping>
        </element>
        <element id="ValueSet.publisher">
            <path value="ValueSet.publisher" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Utgivare" />
            </mapping>
        </element>
        <element id="ValueSet.description">
            <path value="ValueSet.description" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Beskrivning" />
            </mapping>
        </element>
        <element id="ValueSet.compose">
            <path value="ValueSet.compose" />
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.compose.include">
            <path value="ValueSet.compose.include" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kodsystem" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.system">
            <path value="ValueSet.compose.include.system" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kodsystem referens" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.version">
            <path value="ValueSet.compose.include.version" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kodsystem version" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept">
            <path value="ValueSet.compose.include.concept" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Koncept" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.extension">
            <path value="ValueSet.compose.include.concept.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="ValueSet.compose.include.concept.extension:definition">
            <path value="ValueSet.compose.include.concept.extension" />
            <sliceName value="definition" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/valueset-concept-definition" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="ValueSet.compose.include.concept.code">
            <path value="ValueSet.compose.include.concept.code" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kod" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.display">
            <path value="ValueSet.compose.include.concept.display" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Term" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation">
            <path value="ValueSet.compose.include.concept.designation" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Ytterligare ben&#228;mningar" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.language">
            <path value="ValueSet.compose.include.concept.designation.language" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Spr&#229;k" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.use">
            <path value="ValueSet.compose.include.concept.designation.use" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://electronichealth.se/fhir/ValueSet/nll-snomed-designation-use" />
            </binding>
            <mapping>
                <identity value="EHM" />
                <map value="Alternativ ben&#228;mningstyp" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.use.system">
            <path value="ValueSet.compose.include.concept.designation.use.system" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/ValueSet/concept-discriminators" />
            </binding>
            <mapping>
                <identity value="EHM" />
                <map value="Alternativ ben&#228;mningssystemreferens" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.use.code">
            <path value="ValueSet.compose.include.concept.designation.use.code" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Alternativ ben&#228;mningskod" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.use.display">
            <path value="ValueSet.compose.include.concept.designation.use.display" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Alternativ ben&#228;mningsterm" />
            </mapping>
        </element>
        <element id="ValueSet.compose.include.concept.designation.value">
            <path value="ValueSet.compose.include.concept.designation.value" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Alternativ term" />
            </mapping>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://electronichealth.se/fhir/StructureDefinition/NLLValueSet",
    "version": "1.0.0",
    "name": "NLLValueSet",
    "status": "active",
    "date": "2022-02-10",
    "publisher": "Swedish eHealth Agency",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "EHM",
            "name": "E-hälsomyndigheten concept"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "ValueSet",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ValueSet",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ValueSet.id",
                "path": "ValueSet.id",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Värdemängds-id"
                    }
                ]
            },
            {
                "id": "ValueSet.url",
                "path": "ValueSet.url",
                "mustSupport": true
            },
            {
                "id": "ValueSet.version",
                "path": "ValueSet.version",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Version"
                    }
                ]
            },
            {
                "id": "ValueSet.name",
                "path": "ValueSet.name",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Tekniskt namn"
                    }
                ]
            },
            {
                "id": "ValueSet.title",
                "path": "ValueSet.title",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Namn"
                    }
                ]
            },
            {
                "id": "ValueSet.status",
                "path": "ValueSet.status",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Status"
                    }
                ]
            },
            {
                "id": "ValueSet.date",
                "path": "ValueSet.date",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Revisionsdatum"
                    }
                ]
            },
            {
                "id": "ValueSet.publisher",
                "path": "ValueSet.publisher",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Utgivare"
                    }
                ]
            },
            {
                "id": "ValueSet.description",
                "path": "ValueSet.description",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Beskrivning"
                    }
                ]
            },
            {
                "id": "ValueSet.compose",
                "path": "ValueSet.compose",
                "mustSupport": true
            },
            {
                "id": "ValueSet.compose.include",
                "path": "ValueSet.compose.include",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kodsystem"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.system",
                "path": "ValueSet.compose.include.system",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kodsystem referens"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.version",
                "path": "ValueSet.compose.include.version",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kodsystem version"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept",
                "path": "ValueSet.compose.include.concept",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Koncept"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.extension",
                "path": "ValueSet.compose.include.concept.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "ValueSet.compose.include.concept.extension:definition",
                "path": "ValueSet.compose.include.concept.extension",
                "sliceName": "definition",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/valueset-concept-definition"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "ValueSet.compose.include.concept.code",
                "path": "ValueSet.compose.include.concept.code",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kod"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.display",
                "path": "ValueSet.compose.include.concept.display",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Term"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation",
                "path": "ValueSet.compose.include.concept.designation",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Ytterligare benämningar"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.language",
                "path": "ValueSet.compose.include.concept.designation.language",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Språk"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.use",
                "path": "ValueSet.compose.include.concept.designation.use",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://electronichealth.se/fhir/ValueSet/nll-snomed-designation-use"
                },
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Alternativ benämningstyp"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.use.system",
                "path": "ValueSet.compose.include.concept.designation.use.system",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/ValueSet/concept-discriminators"
                },
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Alternativ benämningssystemreferens"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.use.code",
                "path": "ValueSet.compose.include.concept.designation.use.code",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Alternativ benämningskod"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.use.display",
                "path": "ValueSet.compose.include.concept.designation.use.display",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Alternativ benämningsterm"
                    }
                ]
            },
            {
                "id": "ValueSet.compose.include.concept.designation.value",
                "path": "ValueSet.compose.include.concept.designation.value",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Alternativ term"
                    }
                ]
            }
        ]
    }
}
ValueSet..
ValueSet.id..
ValueSet.url..
ValueSet.version..
ValueSet.name..
ValueSet.title..
ValueSet.status..
ValueSet.date..
ValueSet.publisher..
ValueSet.description..
ValueSet.compose..
ValueSet.compose.include..
ValueSet.compose.include.system..
ValueSet.compose.include.version..
ValueSet.compose.include.concept..
ValueSet.compose.include.concept.extension0..
ValueSet.compose.include.concept.extensionExtension0..
ValueSet.compose.include.concept.code..
ValueSet.compose.include.concept.display..
ValueSet.compose.include.concept.designation..
ValueSet.compose.include.concept.designation.language..
ValueSet.compose.include.concept.designation.use..
ValueSet.compose.include.concept.designation.use.system..
ValueSet.compose.include.concept.designation.use.code..
ValueSet.compose.include.concept.designation.use.display..
ValueSet.compose.include.concept.designation.value..

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.

There is an extension, concept.definition, that some value sets use to provide defintions of each concept. Note that the definition is not visible in the 'overview' tab when looking at a value set. The definition is however visible in the Table, XML and JSON tabs.

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) no
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) yes See below for supported extended operations.

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported queries

The following query alternatives are available for this resource.

  1. ../ValueSet
  2. ../ValueSet/[id]
  3. ../ValueSet/[id]/_history{/[vid]}
  4. ../ValueSet?code=[string]

Compartment searches

Compartments are not supported by this resource.

Include & reverse includes

Include and revinclude are not supported by this resource.

For generic information about how to search in FHIR look here.

Search parameters

The table below shows all supported search parameters.

Parameter Description Comment
ValueSet/[id] A read based on the logical ID of a value set
../ValueSet/access-types
_history A vread to get all versions of a value set
../ValueSet/access-types/_history
_history/[vid] A vread to get a specific version of a value set
../ValueSet/access-types/_history/1.0.3
code Code to search for. All value sets containing the code will be returned.
..?code=43067004

Other operations

$validate-code

Invocations

GET ../ValueSet/[id]/$validate-code?code=[string]{&version=[string]}{&date=[string]}{&display=[string]}

This operation does NOT change content.
This operation checks if a code exists in the current version of a specific value set unless a date or version is specified. It can also be used to check the display text.
This is a standard operation in FHIR, see $validate-code for more information.

Parameters (In)

Parameter Description Comment
code Code to search for
..?code=43067004
version Version of the value set
..&version=1.0.3
date Version of the value set at a date
..&date=le2021-03-01
le and eq are supported. No prefix is by default the same as eq.
display A display text to compare with
..&display=h%E5rbotten

Parameters (Out)

Parameter Description Comment
result True if the concept details supplied are valid
true
message Information about the outcome
Koden "14175009" existerar.
display A valid display for the concept if the system wishes to display this to a user
reumatisk ledsjukdom