STU 3 Ballot
TerminologyThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
ShareableValueSet
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="shareablevalueset"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <url value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> <name value="Shareable ValueSet"/> <status value="draft"/> <publisher value="HL7"/> <date value="2016-08-11T17:02:54+10:00"/> <description value="Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets"/> <fhirVersion value="1.6.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="objimpl"/> <uri value="http://hl7.org/fhir/object-implementation"/> <name value="Object Implementation Information"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <mapping> <identity value="define.xml2.0"/> <uri value="http://www.cdisc.org/define-xml"/> <name value="CDISC Define XML 2.0 metadata standard"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="ValueSet"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ValueSet"/> <derivation value="constraint"/> <snapshot> <element id="ValueSet:shareablevalueset"> <path value="ValueSet"/> <name value="ShareableValueSet"/> <short value="A set of codes drawn from one or more code systems"/> <definition value="A value set specifies a set of codes drawn from one or more code systems."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f :reference/@value=concat('#', $id))]))"/> </constraint> <constraint> <key value="vsd-2"/> <severity value="error"/> <human value="A value set with only one import SHALL also have an include and/or an exclude"/> <expression value="compose.import.count() != 1 or compose.include.exists() or compose.exclude.exists()"/> <xpath value="not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude))"/> </constraint> <constraint> <key value="vsd-5"/> <severity value="error"/> <human value="Value set SHALL contain at least one of a a compose, or an expansion element"/> <expression value="compose.exists() or expansion.exists()"/> <xpath value="exists(f:compose) or exists(f:expansion)"/> </constraint> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance"/> </mapping> <mapping> <identity value="w5"/> <map value="conformance.terminology"/> </mapping> </element> <element id="ValueSet:shareablevalueset.id"> <path value="ValueSet.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.meta"> <path value="ValueSet.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.implicitRules"> <path value="ValueSet.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.language"> <path value="ValueSet.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="*"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="ValueSet:shareablevalueset.text"> <path value="ValueSet.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="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."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="ValueSet:shareablevalueset.contained"> <path value="ValueSet.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/> <comments value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.extension"> <path value="ValueSet.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.modifierExtension"> <path value="ValueSet.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.url"> <path value="ValueSet.url"/> <short value="Globally unique logical identifier for value set"/> <definition value="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."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.url"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.url"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="ValueSet:shareablevalueset.identifier"> <path value="ValueSet.identifier"/> <short value="Additional identifier for the value set (e.g. HL7 v2 / CDA)"/> <definition value="A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance."/> <comments value="Typically, this is used for values that can go in an HL7 v3 II data type."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="define.xml2.0"/> <map value="Identifier part"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="ValueSet:shareablevalueset.version"> <path value="ValueSet.version"/> <short value="Logical identifier for this version of the value set"/> <definition value="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."/> <comments value="There may be multiple resource versions of the value set that have the same identifier."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.version"/> </mapping> <mapping> <identity value="w5"/> <map value="id.version"/> </mapping> </element> <element id="ValueSet:shareablevalueset.name"> <path value="ValueSet.name"/> <short value="Informal name for this value set"/> <definition value="A free text natural language name describing the value set."/> <comments value="The name is not expected to be unique. 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."/> <requirements value="Support human navigation."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.name"/> </mapping> </element> <element id="ValueSet:shareablevalueset.status"> <path value="ValueSet.status"/> <short value="draft | active | retired"/> <definition value="The status of the value set."/> <comments value="Allows filtering of value set instances that are appropriate (or not) for use."/> <requirements value="Identify when/if the value set should be used."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The lifecycle status of a Value Set or Concept Map."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/conformance-resource-status"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.status"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="ValueSet:shareablevalueset.experimental"> <path value="ValueSet.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <comments value="Allows filtering of value sets that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.experimental"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="ValueSet:shareablevalueset.publisher"> <path value="ValueSet.publisher"/> <short value="Name of the publisher (organization or individual)"/> <definition value="The name of the individual or organization that published the value set."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the value set. May also allow for contact."/> <alias value="steward"/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.publisher"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.witness"/> </mapping> </element> <element id="ValueSet:shareablevalueset.contact"> <path value="ValueSet.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number, etc."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.contact.id"> <path value="ValueSet.contact.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.contact.extension"> <path value="ValueSet.contact.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.contact.modifierExtension"> <path value="ValueSet.contact.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.contact.name"> <path value="ValueSet.contact.name"/> <short value="Name of an individual to contact"/> <definition value="The name of an individual to contact regarding the value set."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.contact.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.contact.telecom"> <path value="ValueSet.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.contact.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.date"> <path value="ValueSet.date"/> <short value="Date for given status"/> <definition value="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')."/> <comments value="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."/> <requirements value="Need to know when a value set was first legal for use or became withdrawn or replaced."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.date"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.date"/> </mapping> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element id="ValueSet:shareablevalueset.lockedDate"> <path value="ValueSet.lockedDate"/> <short value="Fixed date for all referenced code systems and value sets"/> <definition value="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."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.lockedDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="when.init"/> </mapping> </element> <element id="ValueSet:shareablevalueset.description"> <path value="ValueSet.description"/> <short value="Human language description of the value set"/> <definition value="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."/> <comments value="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."/> <requirements value="Human understandability."/> <alias value="Scope"/> <alias value="Purpose"/> <alias value="scope"/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.useContext"> <path value="ValueSet.useContext"/> <short value="Content intends to support these contexts"/> <definition value="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."/> <requirements value="Assist in searching for appropriate content."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.useContext"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/use-context"/> </valueSetReference> </binding> <mapping> <identity value="define.xml2.0"/> <map value="COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"/> </mapping> <mapping> <identity value="objimpl"/> <map value="BaseConformance.useContext"/> </mapping> </element> <element id="ValueSet:shareablevalueset.immutable"> <path value="ValueSet.immutable"/> <short value="Indicates whether or not any change to the content logical definition may occur"/> <definition value="If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.immutable"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.requirements"> <path value="ValueSet.requirements"/> <short value="Why needed"/> <definition value="Explains why this value set is needed and why it has been constrained as it has."/> <comments value="This element does not describe the usage of the value set (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.requirements"/> <min value="0"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> </element> <element id="ValueSet:shareablevalueset.copyright"> <path value="ValueSet.copyright"/> <short value="Use and/or publishing restrictions"/> <definition value="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."/> <comments value="Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required."/> <alias value="License"/> <alias value="Restrictions"/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.copyright"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.extensible"> <path value="ValueSet.extensible"/> <short value="Whether this is intended to be used with an extensible binding"/> <definition value="Whether this is intended to be used with an extensible binding or not."/> <requirements value="It is not required to say whether this intent applies."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.extensible"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> </element> <element id="ValueSet:shareablevalueset.compose"> <path value="ValueSet.compose"/> <short value="When value set includes codes from elsewhere"/> <definition value="A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.compose"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="vsd-5"/> <constraint> <key value="vsd-1"/> <severity value="error"/> <human value="A value set composition SHALL have an include or an import"/> <expression value="include.exists() or import.exists()"/> <xpath value="exists(f:include) or exists(f:import)"/> </constraint> </element> <element id="ValueSet:shareablevalueset.compose.id"> <path value="ValueSet.compose.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.extension"> <path value="ValueSet.compose.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.modifierExtension"> <path value="ValueSet.compose.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.import"> <path value="ValueSet.compose.import"/> <short value="Import the contents of another value set"/> <definition value="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.url."/> <comments value="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 also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.import"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <condition value="vsd-1"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="ConceptSet"/> </extension> <path value="ValueSet.compose.include"/> <short value="Include one or more codes from a code system"/> <definition value="Include one or more codes from a code system."/> <comments value="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."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.include"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="vsd-1"/> <constraint> <key value="vsd-11"/> <severity value="error"/> <human value="Cannot have both concept and filter"/> <expression value="concept.empty() or filter.empty()"/> <xpath value="not(exists(f:concept)) or not(exists(f:filter))"/> </constraint> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.id"> <path value="ValueSet.compose.include.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.extension"> <path value="ValueSet.compose.include.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.modifierExtension"> <path value="ValueSet.compose.include.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.system"> <path value="ValueSet.compose.include.system"/> <short value="The system the codes come from"/> <definition value="An absolute URI which is the code system from which the selected codes come from."/> <comments value="See ''Coding.system'' for further documentation."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.system"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isSummary value="true"/> <mapping> <identity value="define.xml2.0"/> <map value="ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Href"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.version"> <path value="ValueSet.compose.include.version"/> <short value="Specific version of the code system referred to"/> <definition value="The version of the code system that the codes are selected from."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.compose.include.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="define.xml2.0"/> <map value="ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Version"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="ConceptReference"/> </extension> <path value="ValueSet.compose.include.concept"/> <short value="A concept defined in the system"/> <definition value="Specifies a concept to be included or excluded."/> <comments value="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."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.include.concept"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="vsd-11"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.id"> <path value="ValueSet.compose.include.concept.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.extension"> <path value="ValueSet.compose.include.concept.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.modifierExtension"> <path value="ValueSet.compose.include.concept.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.code"> <path value="ValueSet.compose.include.concept.code"/> <short value="Code or expression from system"/> <definition value="Specifies a code for the concept to be included or excluded."/> <comments value="Expressions are allowed if defined by the underlying code system."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.concept.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.display"> <path value="ValueSet.compose.include.concept.display"/> <short value="Text to display for this code for this value set"/> <definition value="The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.compose.include.concept.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation"> <path value="ValueSet.compose.include.concept.designation"/> <short value="Additional representations for this valueset"/> <definition value="Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.include.concept.designation"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.id"> <path value="ValueSet.compose.include.concept.designation.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.extension"> <path value="ValueSet.compose.include.concept.designation.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.modifierExtension"> <path value="ValueSet.compose.include.concept.designation.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.language"> <path value="ValueSet.compose.include.concept.designation.language"/> <short value="Human language of the designation"/> <definition value="The language this designation is defined for."/> <comments value="In the absence of a language, the resource language applies."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.compose.include.concept.designation.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.use"> <path value="ValueSet.compose.include.concept.designation.use"/> <short value="Details how this designation would be used"/> <definition value="A code that details how this designation would be used."/> <comments value="If no use is provided, the designation can be assumed to be suitable for general display to a human user."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.compose.include.concept.designation.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <binding> <strength value="extensible"/> <description value="Details of how a designation would be used."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/designation-use"/> </valueSetReference> </binding> </element> <element id="ValueSet:shareablevalueset.compose.include.concept.designation.value"> <path value="ValueSet.compose.include.concept.designation.value"/> <short value="The text value for this designation"/> <definition value="The text value for this designation."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.concept.designation.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.compose.include.filter"> <path value="ValueSet.compose.include.filter"/> <short value="Select codes/concepts by their properties (including relationships)"/> <definition value="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."/> <comments value="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."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.include.filter"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="vsd-11"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.id"> <path value="ValueSet.compose.include.filter.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.extension"> <path value="ValueSet.compose.include.filter.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.modifierExtension"> <path value="ValueSet.compose.include.filter.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.property"> <path value="ValueSet.compose.include.filter.property"/> <short value="A property defined by the code system"/> <definition value="A code that identifies a property defined in the code system."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.filter.property"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.op"> <path value="ValueSet.compose.include.filter.op"/> <short value="= | is-a | is-not-a | regex | in | not-in | generalizes"/> <definition value="The kind of operation to perform as a part of the filter criteria."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.filter.op"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="The kind of operation to perform as a part of a property based filter."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/filter-operator"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.include.filter.value"> <path value="ValueSet.compose.include.filter.value"/> <short value="Code from the system, or regex criteria"/> <definition value="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."/> <comments value="Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.compose.include.filter.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.compose.exclude"> <path value="ValueSet.compose.exclude"/> <short value="Explicitly exclude codes"/> <definition value="Exclude one or more codes from the value set."/> <comments value="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."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.compose.exclude"/> <min value="0"/> <max value="*"/> </base> <contentReference value="#ValueSet:shareablevalueset.compose.include"/> <condition value="vsd-2"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion"> <path value="ValueSet.expansion"/> <short value="Used when the value set is "expanded""/> <definition value="A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed."/> <comments value="Expansion is performed to produce a collection of codes that are ready to use for data entry or validation."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="vsd-5"/> </element> <element id="ValueSet:shareablevalueset.expansion.id"> <path value="ValueSet.expansion.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.extension"> <path value="ValueSet.expansion.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.modifierExtension"> <path value="ValueSet.expansion.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.identifier"> <path value="ValueSet.expansion.identifier"/> <short value="Uniquely identifies this expansion"/> <definition value="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."/> <comments value="Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd)."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.expansion.identifier"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.timestamp"> <path value="ValueSet.expansion.timestamp"/> <short value="Time ValueSet expansion happened"/> <definition value="The time at which the expansion was produced by the expanding system."/> <comments value="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."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.expansion.timestamp"/> <min value="1"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.total"> <path value="ValueSet.expansion.total"/> <short value="Total number of codes in the expansion"/> <definition value="The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter."/> <comments value="Paging only applies to flat expansions."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.total"/> <min value="0"/> <max value="1"/> </base> <type> <code value="integer"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.offset"> <path value="ValueSet.expansion.offset"/> <short value="Offset at which this resource starts"/> <definition value="If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.offset"/> <min value="0"/> <max value="1"/> </base> <type> <code value="integer"/> </type> <meaningWhenMissing value="Paging is not being used"/> </element> <element id="ValueSet:shareablevalueset.expansion.parameter"> <path value="ValueSet.expansion.parameter"/> <short value="Parameter that controlled the expansion process"/> <definition value="A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion."/> <comments value="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)."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.expansion.parameter"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.parameter.id"> <path value="ValueSet.expansion.parameter.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.parameter.extension"> <path value="ValueSet.expansion.parameter.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.parameter.modifierExtension"> <path value="ValueSet.expansion.parameter.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.parameter.name"> <path value="ValueSet.expansion.parameter.name"/> <short value="Name as assigned by the server"/> <definition value="The name of the parameter."/> <comments value="The names are assigned at the discretion of the server."/> <min value="1"/> <max value="1"/> <base> <path value="ValueSet.expansion.parameter.name"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.parameter.value[x]"> <path value="ValueSet.expansion.parameter.value[x]"/> <short value="Value of the named parameter"/> <definition value="The value of the parameter."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.parameter.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <type> <code value="decimal"/> </type> <type> <code value="uri"/> </type> <type> <code value="code"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.contains"> <path value="ValueSet.expansion.contains"/> <short value="Codes in the value set"/> <definition value="The codes that are contained in the value set expansion."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.expansion.contains"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="vsd-6"/> <severity value="error"/> <human value="SHALL have a code or a display"/> <expression value="code.exists() or display.exists()"/> <xpath value="exists(f:code) or exists(f:display)"/> </constraint> <constraint> <key value="vsd-9"/> <severity value="error"/> <human value="Must have a code if not abstract"/> <expression value="code.exists() or abstract = true"/> <xpath value="exists(f:code) or (f:abstract/@value = true())"/> </constraint> <constraint> <key value="vsd-10"/> <severity value="error"/> <human value="Must have a system if a code is present"/> <expression value="code.empty() or system.exists()"/> <xpath value="exists(f:system) or not(exists(f:code))"/> </constraint> </element> <element id="ValueSet:shareablevalueset.expansion.contains.id"> <path value="ValueSet.expansion.contains.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.contains.extension"> <path value="ValueSet.expansion.contains.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.contains.modifierExtension"> <path value="ValueSet.expansion.contains.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.expansion.contains.system"> <path value="ValueSet.expansion.contains.system"/> <short value="System value for the code"/> <definition value="An absolute URI which is the code system in which the code for this item in the expansion is defined."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.contains.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.contains.abstract"> <path value="ValueSet.expansion.contains.abstract"/> <short value="If user cannot select this entry"/> <definition value="If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value."/> <comments value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.contains.abstract"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <defaultValueBoolean value="false"/> </element> <element id="ValueSet:shareablevalueset.expansion.contains.version"> <path value="ValueSet.expansion.contains.version"/> <short value="Version in which this code/display is defined"/> <definition value="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."/> <comments value="The exact value of the version string is specified by the system from which the code is derived."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.contains.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.expansion.contains.code"> <path value="ValueSet.expansion.contains.code"/> <short value="Code - if blank, this is not a selectable code"/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.contains.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="vsd-6"/> </element> <element id="ValueSet:shareablevalueset.expansion.contains.display"> <path value="ValueSet.expansion.contains.display"/> <short value="User display for the concept"/> <definition value="The recommended display for this item in the expansion."/> <min value="0"/> <max value="1"/> <base> <path value="ValueSet.expansion.contains.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="vsd-6"/> </element> <element id="ValueSet:shareablevalueset.expansion.contains.contains"> <path value="ValueSet.expansion.contains.contains"/> <short value="Codes contained under this entry"/> <definition value="Other codes and entries contained under this entry in the hierarchy."/> <comments value="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."/> <min value="0"/> <max value="*"/> <base> <path value="ValueSet.expansion.contains.contains"/> <min value="0"/> <max value="*"/> </base> <contentReference value="#ValueSet:shareablevalueset.expansion.contains"/> </element> </snapshot> <differential> <element id="ValueSet:shareablevalueset"> <path value="ValueSet"/> <name value="ShareableValueSet"/> <min value="1"/> <max value="1"/> </element> <element id="ValueSet:shareablevalueset.url"> <path value="ValueSet.url"/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element id="ValueSet:shareablevalueset.version"> <path value="ValueSet.version"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.name"> <path value="ValueSet.name"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.status"> <path value="ValueSet.status"/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.experimental"> <path value="ValueSet.experimental"/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element id="ValueSet:shareablevalueset.publisher"> <path value="ValueSet.publisher"/> <alias value="steward"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="ValueSet:shareablevalueset.description"> <path value="ValueSet.description"/> <alias value="scope"/> <min value="1"/> <max value="1"/> <type> <code value="markdown"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="ValueSet:shareablevalueset.immutable"> <path value="ValueSet.immutable"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> </differential> </StructureDefinition>
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:05+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change