Generated Narrative: ConceptMap R3-ValueSet-element-map-to-R4 Mapping from http://hl7.org/fhir/3.0 to http://hl7.org/fhir/4.0 Group 1 Mapping from http://hl7.org/fhir/StructureDefinition/ValueSet|3.0.2 to ValueSetversion: 4.0.1) Source Code Relationship Target Code Comment ValueSet.meta (meta) is equivalent to ValueSet.meta Element `ValueSet.meta` is mapped to FHIR R4 element `ValueSet.meta` as `Equivalent`. ValueSet.implicitRules (implicitRules) is equivalent to ValueSet.implicitRules Element `ValueSet.implicitRules` is mapped to FHIR R4 element `ValueSet.implicitRules` as `Equivalent`. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. ValueSet.language (language) is equivalent to ValueSet.language Element `ValueSet.language` is mapped to FHIR R4 element `ValueSet.language` as `Equivalent`. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). ValueSet.text (text) is equivalent to ValueSet.text Element `ValueSet.text` is mapped to FHIR R4 element `ValueSet.text` as `Equivalent`. 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 in formation is added later. ValueSet.contained (contained) is equivalent to ValueSet.contained Element `ValueSet.contained` is mapped to FHIR R4 element `ValueSet.contained` as `Equivalent`. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. ValueSet.url (url) is equivalent to ValueSet.url Element `ValueSet.url` is mapped to FHIR R4 element `ValueSet.url` as `Equivalent`. 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. ValueSet.identifier (identifier) is equivalent to ValueSet.identifier Element `ValueSet.identifier` is mapped to FHIR R4 element `ValueSet.identifier` as `Equivalent`. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this value set outside of FHIR, where it is not possible to use the logical URI. ValueSet.version (version) is equivalent to ValueSet.version Element `ValueSet.version` is mapped to FHIR R4 element `ValueSet.version` as `Equivalent`. 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 refrence to a particular business version of the value set with the format [url]|[version]. ValueSet.name (name) is equivalent to ValueSet.name Element `ValueSet.name` is mapped to FHIR R4 element `ValueSet.name` as `Equivalent`. The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable 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. ValueSet.title (title) is equivalent to ValueSet.title Element `ValueSet.title` is mapped to FHIR R4 element `ValueSet.title` as `Equivalent`. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. ValueSet.status (status) is equivalent to ValueSet.status Element `ValueSet.status` is mapped to FHIR R4 element `ValueSet.status` as `Equivalent`. Allows filtering of value sets that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired value set without due consideration. ValueSet.experimental (experimental) is equivalent to ValueSet.experimental Element `ValueSet.experimental` is mapped to FHIR R4 element `ValueSet.experimental` as `Equivalent`. Allows filtering of value set that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental value set in production. ValueSet.date (date) is equivalent to ValueSet.date Element `ValueSet.date` is mapped to FHIR R4 element `ValueSet.date` as `Equivalent`. 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. ValueSet.publisher (publisher) is equivalent to ValueSet.publisher Element `ValueSet.publisher` is mapped to FHIR R4 element `ValueSet.publisher` as `Equivalent`. 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. ValueSet.contact (contact) is equivalent to ValueSet.contact Element `ValueSet.contact` is mapped to FHIR R4 element `ValueSet.contact` as `Equivalent`. May be a web site, an email address, a telephone number, etc. ValueSet.description (description) is equivalent to ValueSet.description Element `ValueSet.description` is mapped to FHIR R4 element `ValueSet.description` as `Equivalent`. 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 profile is presumed to be the predominant language in the place the profile 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. ValueSet.useContext (useContext) is equivalent to ValueSet.useContext Element `ValueSet.useContext` is mapped to FHIR R4 element `ValueSet.useContext` as `Equivalent`. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. ValueSet.jurisdiction (jurisdiction) is equivalent to ValueSet.jurisdiction Element `ValueSet.jurisdiction` is mapped to FHIR R4 element `ValueSet.jurisdiction` as `Equivalent`. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended. ValueSet.immutable (immutable) is equivalent to ValueSet.immutable Element `ValueSet.immutable` is mapped to FHIR R4 element `ValueSet.immutable` as `Equivalent`. 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. ValueSet.purpose (purpose) is equivalent to ValueSet.purpose Element `ValueSet.purpose` is mapped to FHIR R4 element `ValueSet.purpose` as `Equivalent`. 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. ValueSet.copyright (copyright) is equivalent to ValueSet.copyright Element `ValueSet.copyright` is mapped to FHIR R4 element `ValueSet.copyright` as `Equivalent`. null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required. ValueSet.compose (compose) maps to wider concept ValueSet.compose Element `ValueSet.compose` is mapped to FHIR R4 element `ValueSet.compose` as `Equivalent`. ValueSet.compose.lockedDate (lockedDate) is equivalent to ValueSet.compose.lockedDate Element `ValueSet.compose.lockedDate` is mapped to FHIR R4 element `ValueSet.compose.lockedDate` as `Equivalent`. 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. ValueSet.compose.inactive (inactive) is equivalent to ValueSet.compose.inactive Element `ValueSet.compose.inactive` is mapped to FHIR R4 element `ValueSet.compose.inactive` as `Equivalent`. Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems (e.g. LOINC, deprecated means 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. ValueSet.compose.include (include) maps to wider concept ValueSet.compose.include Element `ValueSet.compose.include` is mapped to FHIR R4 element `ValueSet.compose.include` as `Equivalent`. 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'. ValueSet.compose.include.system (system) is equivalent to ValueSet.compose.include.system Element `ValueSet.compose.include.system` is mapped to FHIR R4 element `ValueSet.compose.include.system` as `Equivalent`. 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. ValueSet.compose.include.version (version) is equivalent to ValueSet.compose.include.version Element `ValueSet.compose.include.version` is mapped to FHIR R4 element `ValueSet.compose.include.version` as `Equivalent`. 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 may not be known until a context of use binds it to a particular version. ValueSet.compose.include.concept (concept) maps to wider concept ValueSet.compose.include.concept Element `ValueSet.compose.include.concept` is mapped to FHIR R4 element `ValueSet.compose.include.concept` as `Equivalent`. The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element. ValueSet.compose.include.concept.code (code) is equivalent to ValueSet.compose.include.concept.code Element `ValueSet.compose.include.concept.code` is mapped to FHIR R4 element `ValueSet.compose.include.concept.code` as `Equivalent`. Expressions are allowed if defined by the underlying code system. ValueSet.compose.include.concept.display (display) is equivalent to ValueSet.compose.include.concept.display Element `ValueSet.compose.include.concept.display` is mapped to FHIR R4 element `ValueSet.compose.include.concept.display` as `Equivalent`. The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element. ValueSet.compose.include.concept.designation (designation) maps to wider concept ValueSet.compose.include.concept.designation Element `ValueSet.compose.include.concept.designation` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation` as `Equivalent`. ValueSet.compose.include.concept.designation.language (language) is equivalent to ValueSet.compose.include.concept.designation.language Element `ValueSet.compose.include.concept.designation.language` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.language` as `Equivalent`. In the absence of a language, the resource language applies. ValueSet.compose.include.concept.designation.use (use) is equivalent to ValueSet.compose.include.concept.designation.use Element `ValueSet.compose.include.concept.designation.use` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.use` as `Equivalent`. If no use is provided, the designation can be assumed to be suitable for general display to a human user. ValueSet.compose.include.concept.designation.value (value) is equivalent to ValueSet.compose.include.concept.designation.value Element `ValueSet.compose.include.concept.designation.value` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.value` as `Equivalent`. ValueSet.compose.include.filter (filter) maps to wider concept ValueSet.compose.include.filter Element `ValueSet.compose.include.filter` is mapped to FHIR R4 element `ValueSet.compose.include.filter` as `Equivalent`. Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party. ValueSet.compose.include.filter.property (property) is equivalent to ValueSet.compose.include.filter.property Element `ValueSet.compose.include.filter.property` is mapped to FHIR R4 element `ValueSet.compose.include.filter.property` as `Equivalent`. ValueSet.compose.include.filter.op (op) is equivalent to ValueSet.compose.include.filter.op Element `ValueSet.compose.include.filter.op` is mapped to FHIR R4 element `ValueSet.compose.include.filter.op` as `Equivalent`. ValueSet.compose.include.filter.value (value) is equivalent to ValueSet.compose.include.filter.value Element `ValueSet.compose.include.filter.value` is mapped to FHIR R4 element `ValueSet.compose.include.filter.value` as `Equivalent`. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example. ValueSet.compose.include.valueSet (valueSet) is equivalent to ValueSet.compose.include.valueSet Element `ValueSet.compose.include.valueSet` is mapped to FHIR R4 element `ValueSet.compose.include.valueSet` as `Equivalent`. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may 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. ValueSet.compose.exclude (exclude) is equivalent to ValueSet.compose.exclude Element `ValueSet.compose.exclude` is mapped to FHIR R4 element `ValueSet.compose.exclude` as `Equivalent`. Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored. ValueSet.expansion (expansion) maps to wider concept ValueSet.expansion Element `ValueSet.expansion` is mapped to FHIR R4 element `ValueSet.expansion` as `Equivalent`. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. ValueSet.expansion.identifier (identifier) is equivalent to ValueSet.expansion.identifier Element `ValueSet.expansion.identifier` is mapped to FHIR R4 element `ValueSet.expansion.identifier` as `Equivalent`. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd). ValueSet.expansion.timestamp (timestamp) is equivalent to ValueSet.expansion.timestamp Element `ValueSet.expansion.timestamp` is mapped to FHIR R4 element `ValueSet.expansion.timestamp` as `Equivalent`. 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. ValueSet.expansion.total (total) is equivalent to ValueSet.expansion.total Element `ValueSet.expansion.total` is mapped to FHIR R4 element `ValueSet.expansion.total` as `Equivalent`. Paging only applies to flat expansions. ValueSet.expansion.offset (offset) is equivalent to ValueSet.expansion.offset Element `ValueSet.expansion.offset` is mapped to FHIR R4 element `ValueSet.expansion.offset` as `Equivalent`. 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. ValueSet.expansion.parameter (parameter) maps to wider concept ValueSet.expansion.parameter Element `ValueSet.expansion.parameter` is mapped to FHIR R4 element `ValueSet.expansion.parameter` as `Equivalent`. The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any). ValueSet.expansion.parameter.name (name) is equivalent to ValueSet.expansion.parameter.name Element `ValueSet.expansion.parameter.name` is mapped to FHIR R4 element `ValueSet.expansion.parameter.name` as `Equivalent`. The names are assigned at the discretion of the server. ValueSet.expansion.parameter.value[x] (value[x]) is equivalent to ValueSet.expansion.parameter.value[x] Element `ValueSet.expansion.parameter.value[x]` is mapped to FHIR R4 element `ValueSet.expansion.parameter.value[x]` as `RelatedTo`. The target context `ValueSet.expansion.parameter.value[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ValueSet.expansion.parameter`. ValueSet.expansion.contains (contains) maps to wider concept ValueSet.expansion.contains Element `ValueSet.expansion.contains` is mapped to FHIR R4 element `ValueSet.expansion.contains` as `Equivalent`. ValueSet.expansion.contains.system (system) is equivalent to ValueSet.expansion.contains.system Element `ValueSet.expansion.contains.system` is mapped to FHIR R4 element `ValueSet.expansion.contains.system` as `Equivalent`. ValueSet.expansion.contains.abstract (abstract) is equivalent to ValueSet.expansion.contains.abstract Element `ValueSet.expansion.contains.abstract` is mapped to FHIR R4 element `ValueSet.expansion.contains.abstract` as `Equivalent`. 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. ValueSet.expansion.contains.inactive (inactive) is equivalent to ValueSet.expansion.contains.inactive Element `ValueSet.expansion.contains.inactive` is mapped to FHIR R4 element `ValueSet.expansion.contains.inactive` as `Equivalent`. This should only have a value if the concept is inactive. ValueSet.expansion.contains.version (version) is equivalent to ValueSet.expansion.contains.version Element `ValueSet.expansion.contains.version` is mapped to FHIR R4 element `ValueSet.expansion.contains.version` as `Equivalent`. The exact value of the version string is specified by the system from which the code is derived. ValueSet.expansion.contains.code (code) is equivalent to ValueSet.expansion.contains.code Element `ValueSet.expansion.contains.code` is mapped to FHIR R4 element `ValueSet.expansion.contains.code` as `Equivalent`. ValueSet.expansion.contains.display (display) is equivalent to ValueSet.expansion.contains.display Element `ValueSet.expansion.contains.display` is mapped to FHIR R4 element `ValueSet.expansion.contains.display` as `Equivalent`. ValueSet.expansion.contains.designation (designation) is equivalent to ValueSet.expansion.contains.designation Element `ValueSet.expansion.contains.designation` is mapped to FHIR R4 element `ValueSet.expansion.contains.designation` as `Equivalent`. The designations provided must be based on the value set and code system definitions. ValueSet.expansion.contains.contains (contains) is equivalent to ValueSet.expansion.contains.contains Element `ValueSet.expansion.contains.contains` is mapped to FHIR R4 element `ValueSet.expansion.contains.contains` as `Equivalent`. 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. Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/ValueSet|3.0.2 to STU3: Whether this is intended to be used with an extensible binding (new)version: 0.1.0) Source Code Relationship Target Code Comment ValueSet.extensible (extensible) is equivalent to Extension (STU3: Whether this is intended to be used with an extensible binding (new)) Element `ValueSet.extensible` has a context of ValueSet based on following the parent source element upwards and mapping to `ValueSet`. Element `ValueSet.extensible` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Cross-version mapping for FHIR STU3 ValueSet to FHIR R4 ValueSet
This ConceptMap represents cross-version mappings for elements from a FHIR STU3 ValueSet to FHIR R4.
Element `ValueSet.meta` is mapped to FHIR R4 element `ValueSet.meta` as `Equivalent`.
Element `ValueSet.implicitRules` is mapped to FHIR R4 element `ValueSet.implicitRules` as `Equivalent`. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Element `ValueSet.language` is mapped to FHIR R4 element `ValueSet.language` as `Equivalent`. 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).
Element `ValueSet.text` is mapped to FHIR R4 element `ValueSet.text` as `Equivalent`. 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 in formation is added later.
Element `ValueSet.contained` is mapped to FHIR R4 element `ValueSet.contained` as `Equivalent`. 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.
Element `ValueSet.url` is mapped to FHIR R4 element `ValueSet.url` as `Equivalent`. 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.
Element `ValueSet.identifier` is mapped to FHIR R4 element `ValueSet.identifier` as `Equivalent`. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this value set outside of FHIR, where it is not possible to use the logical URI.
Element `ValueSet.version` is mapped to FHIR R4 element `ValueSet.version` as `Equivalent`. 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 refrence to a particular business version of the value set with the format [url]|[version].
Element `ValueSet.name` is mapped to FHIR R4 element `ValueSet.name` as `Equivalent`. The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable 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.
Element `ValueSet.title` is mapped to FHIR R4 element `ValueSet.title` as `Equivalent`. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Element `ValueSet.status` is mapped to FHIR R4 element `ValueSet.status` as `Equivalent`. Allows filtering of value sets that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired value set without due consideration.
Element `ValueSet.experimental` is mapped to FHIR R4 element `ValueSet.experimental` as `Equivalent`. Allows filtering of value set that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental value set in production.
Element `ValueSet.date` is mapped to FHIR R4 element `ValueSet.date` as `Equivalent`. 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.
Element `ValueSet.publisher` is mapped to FHIR R4 element `ValueSet.publisher` as `Equivalent`. 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.
Element `ValueSet.contact` is mapped to FHIR R4 element `ValueSet.contact` as `Equivalent`. May be a web site, an email address, a telephone number, etc.
Element `ValueSet.description` is mapped to FHIR R4 element `ValueSet.description` as `Equivalent`. 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 profile is presumed to be the predominant language in the place the profile 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.
Element `ValueSet.useContext` is mapped to FHIR R4 element `ValueSet.useContext` as `Equivalent`. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Element `ValueSet.jurisdiction` is mapped to FHIR R4 element `ValueSet.jurisdiction` as `Equivalent`. It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
Element `ValueSet.immutable` is mapped to FHIR R4 element `ValueSet.immutable` as `Equivalent`. 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.
Element `ValueSet.purpose` is mapped to FHIR R4 element `ValueSet.purpose` as `Equivalent`. 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.
Element `ValueSet.copyright` is mapped to FHIR R4 element `ValueSet.copyright` as `Equivalent`. null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
Element `ValueSet.compose` is mapped to FHIR R4 element `ValueSet.compose` as `Equivalent`.
Element `ValueSet.compose.lockedDate` is mapped to FHIR R4 element `ValueSet.compose.lockedDate` as `Equivalent`. 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.
Element `ValueSet.compose.inactive` is mapped to FHIR R4 element `ValueSet.compose.inactive` as `Equivalent`. Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems (e.g. LOINC, deprecated means 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.
Element `ValueSet.compose.include` is mapped to FHIR R4 element `ValueSet.compose.include` as `Equivalent`. 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'.
Element `ValueSet.compose.include.system` is mapped to FHIR R4 element `ValueSet.compose.include.system` as `Equivalent`. 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.
Element `ValueSet.compose.include.version` is mapped to FHIR R4 element `ValueSet.compose.include.version` as `Equivalent`. 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 may not be known until a context of use binds it to a particular version.
Element `ValueSet.compose.include.concept` is mapped to FHIR R4 element `ValueSet.compose.include.concept` as `Equivalent`. The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.
Element `ValueSet.compose.include.concept.code` is mapped to FHIR R4 element `ValueSet.compose.include.concept.code` as `Equivalent`. Expressions are allowed if defined by the underlying code system.
Element `ValueSet.compose.include.concept.display` is mapped to FHIR R4 element `ValueSet.compose.include.concept.display` as `Equivalent`. 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.
Element `ValueSet.compose.include.concept.designation` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation` as `Equivalent`.
Element `ValueSet.compose.include.concept.designation.language` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.language` as `Equivalent`. In the absence of a language, the resource language applies.
Element `ValueSet.compose.include.concept.designation.use` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.use` as `Equivalent`. If no use is provided, the designation can be assumed to be suitable for general display to a human user.
Element `ValueSet.compose.include.concept.designation.value` is mapped to FHIR R4 element `ValueSet.compose.include.concept.designation.value` as `Equivalent`.
Element `ValueSet.compose.include.filter` is mapped to FHIR R4 element `ValueSet.compose.include.filter` as `Equivalent`. 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.
Element `ValueSet.compose.include.filter.property` is mapped to FHIR R4 element `ValueSet.compose.include.filter.property` as `Equivalent`.
Element `ValueSet.compose.include.filter.op` is mapped to FHIR R4 element `ValueSet.compose.include.filter.op` as `Equivalent`.
Element `ValueSet.compose.include.filter.value` is mapped to FHIR R4 element `ValueSet.compose.include.filter.value` as `Equivalent`. Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
Element `ValueSet.compose.include.valueSet` is mapped to FHIR R4 element `ValueSet.compose.include.valueSet` as `Equivalent`. The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may 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.
Element `ValueSet.compose.exclude` is mapped to FHIR R4 element `ValueSet.compose.exclude` as `Equivalent`. 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.
Element `ValueSet.expansion` is mapped to FHIR R4 element `ValueSet.expansion` as `Equivalent`. Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.
Element `ValueSet.expansion.identifier` is mapped to FHIR R4 element `ValueSet.expansion.identifier` as `Equivalent`. Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).
Element `ValueSet.expansion.timestamp` is mapped to FHIR R4 element `ValueSet.expansion.timestamp` as `Equivalent`. 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.
Element `ValueSet.expansion.total` is mapped to FHIR R4 element `ValueSet.expansion.total` as `Equivalent`. Paging only applies to flat expansions.
Element `ValueSet.expansion.offset` is mapped to FHIR R4 element `ValueSet.expansion.offset` as `Equivalent`. 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.
Element `ValueSet.expansion.parameter` is mapped to FHIR R4 element `ValueSet.expansion.parameter` as `Equivalent`. The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).
Element `ValueSet.expansion.parameter.name` is mapped to FHIR R4 element `ValueSet.expansion.parameter.name` as `Equivalent`. The names are assigned at the discretion of the server.
Element `ValueSet.expansion.parameter.value[x]` is mapped to FHIR R4 element `ValueSet.expansion.parameter.value[x]` as `RelatedTo`. The target context `ValueSet.expansion.parameter.value[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ValueSet.expansion.parameter`.
Element `ValueSet.expansion.contains` is mapped to FHIR R4 element `ValueSet.expansion.contains` as `Equivalent`.
Element `ValueSet.expansion.contains.system` is mapped to FHIR R4 element `ValueSet.expansion.contains.system` as `Equivalent`.
Element `ValueSet.expansion.contains.abstract` is mapped to FHIR R4 element `ValueSet.expansion.contains.abstract` as `Equivalent`. 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.
Element `ValueSet.expansion.contains.inactive` is mapped to FHIR R4 element `ValueSet.expansion.contains.inactive` as `Equivalent`. This should only have a value if the concept is inactive.
Element `ValueSet.expansion.contains.version` is mapped to FHIR R4 element `ValueSet.expansion.contains.version` as `Equivalent`. The exact value of the version string is specified by the system from which the code is derived.
Element `ValueSet.expansion.contains.code` is mapped to FHIR R4 element `ValueSet.expansion.contains.code` as `Equivalent`.
Element `ValueSet.expansion.contains.display` is mapped to FHIR R4 element `ValueSet.expansion.contains.display` as `Equivalent`.
Element `ValueSet.expansion.contains.designation` is mapped to FHIR R4 element `ValueSet.expansion.contains.designation` as `Equivalent`. The designations provided must be based on the value set and code system definitions.
Element `ValueSet.expansion.contains.contains` is mapped to FHIR R4 element `ValueSet.expansion.contains.contains` as `Equivalent`. 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.
Element `ValueSet.extensible` has a context of ValueSet based on following the parent source element upwards and mapping to `ValueSet`. Element `ValueSet.extensible` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).