extension shown: fhir [x]

shareablevalueset

Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/shareablevalueset

Thing > Resource > DomainResource > ValueSet > shareablevalueset
conformance.terminology > ValueSet > shareablevalueset

Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from shareablevalueset
ValueSet.codeSystem.caseSensitive Boolean If code comparison is case sensitive when codes within this system are compared to each other.
ValueSet.codeSystem.concept.abstract Boolean If this code is not for use as a real concept.
ValueSet.codeSystem.concept.code Text A code - a text symbol - that uniquely identifies the concept within the code system.
ValueSet.codeSystem.concept.definition Text The formal definition of the concept. The value set resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
ValueSet.codeSystem.concept.display Text A human readable string that is the recommended default way to present this concept to a user.
ValueSet.codeSystem.system Text An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.
ValueSet.codeSystem.version Text The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.
ValueSet.description Text A free text natural language description of the use of the value set - reason for definition, "the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
ValueSet.experimental Boolean This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
ValueSet.immutable Boolean If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
ValueSet.name Text A free text natural language name describing the value set.
ValueSet.publisher Text The name of the individual or organization that published the value set.
ValueSet.status conformance-resource-status The status of the value set.
ValueSet.url Text An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published.
ValueSet.version Text 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 profile author manually and the value should be a timestamp.
Properties from ValueSet
ValueSet.codeSystem BackboneElement A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly.
ValueSet.codeSystem.caseSensitive Boolean If code comparison is case sensitive when codes within this system are compared to each other.
ValueSet.codeSystem.concept BackboneElement Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.
ValueSet.codeSystem.concept.abstract Boolean If this code is not for use as a real concept.
ValueSet.codeSystem.concept.code Text A code - a text symbol - that uniquely identifies the concept within the code system.
ValueSet.codeSystem.concept.definition Text The formal definition of the concept. The value set resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
ValueSet.codeSystem.concept.designation BackboneElement Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
ValueSet.codeSystem.concept.designation.language http://tools.ietf.org/html/bcp47 The language this designation is defined for.
ValueSet.codeSystem.concept.designation.use Coding A code that details how this designation would be used.
ValueSet.codeSystem.concept.designation.value Text The text value for this designation.
ValueSet.codeSystem.concept.display Text A human readable string that is the recommended default way to present this concept to a user.
ValueSet.codeSystem.system Text An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.
ValueSet.codeSystem.version Text The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.
ValueSet.compose BackboneElement A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.
ValueSet.compose.import Text Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri.
ValueSet.compose.include BackboneElement Include one or more codes from a code system.
ValueSet.compose.include.concept BackboneElement Specifies a concept to be included or excluded.
ValueSet.compose.include.concept.code Text Specifies a code for the concept to be included or excluded.
ValueSet.compose.include.concept.display Text The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
ValueSet.compose.include.filter BackboneElement Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.
ValueSet.compose.include.filter.op filter-operator The kind of operation to perform as a part of the filter criteria.
ValueSet.compose.include.filter.property Text A code that identifies a property defined in the code system.
ValueSet.compose.include.filter.value Text The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value.
ValueSet.compose.include.system Text An absolute URI which is the code system from which the selected codes come from.
ValueSet.compose.include.version Text The version of the code system that the codes are selected from.
ValueSet.contact BackboneElement Contacts to assist a user in finding and communicating with the publisher.
ValueSet.contact.name Text The name of an individual to contact regarding the value set.
ValueSet.contact.telecom ContactPoint Contact details for individual (if a name was provided) or the publisher.
ValueSet.copyright Text A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
ValueSet.date DateTime The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition').
ValueSet.description Text A free text natural language description of the use of the value set - reason for definition, "the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
ValueSet.expansion BackboneElement A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
ValueSet.expansion.contains BackboneElement The codes that are contained in the value set expansion.
ValueSet.expansion.contains.abstract Boolean If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
ValueSet.expansion.contains.code Text The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
ValueSet.expansion.contains.display Text The recommended display for this item in the expansion.
ValueSet.expansion.contains.system Text An absolute URI which is the code system in which the code for this item in the expansion is defined.
ValueSet.expansion.contains.version Text The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.
ValueSet.expansion.identifier Text An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.
ValueSet.expansion.offset Number If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.
ValueSet.expansion.parameter BackboneElement A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
ValueSet.expansion.parameter.name Text The name of the parameter.
ValueSet.expansion.parameter.valueboolean Boolean The value of the parameter.
ValueSet.expansion.parameter.valuecode Text The value of the parameter.
ValueSet.expansion.parameter.valuedecimal Number The value of the parameter.
ValueSet.expansion.parameter.valueinteger Number The value of the parameter.
ValueSet.expansion.parameter.valuestring Text The value of the parameter.
ValueSet.expansion.parameter.valueuri Text The value of the parameter.
ValueSet.expansion.timestamp DateTime The time at which the expansion was produced by the expanding system.
ValueSet.expansion.total Number The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
ValueSet.experimental Boolean This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
ValueSet.extensible Boolean Whether this is intended to be used with an extensible binding or not.
ValueSet.identifier Identifier 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.
ValueSet.immutable Boolean If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
ValueSet.lockedDate Date If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date.
ValueSet.name Text A free text natural language name describing the value set.
ValueSet.publisher Text The name of the individual or organization that published the value set.
ValueSet.requirements Text Explains why this value set is needed and why it has been constrained as it has.
ValueSet.status conformance-resource-status The status of the value set.
ValueSet.url Text An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published.
ValueSet.useContext use-context The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
ValueSet.version Text 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 profile author manually and the value should be a timestamp.
Properties from DomainResource
DomainResource.contained Resource These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
DomainResource.modifierExtension Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may 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.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image URL  or
ImageObject 
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Schema Version 2.2