Generated Narrative: StructureDefinition athena-valueset-profile Name Flags Card. Type Description & Constraints ValueSet 0..* ValueSet A set of codes drawn from one or more code systems url 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique) identifier 0..1 Identifier Additional identifier for the value set (business identifier) version 0..1 string Business version of the value set name 0..1 string Name for this value set (computer friendly) status S 1..1 code draft | active | retired | unknown experimental 0..1 boolean For testing purposes, not real usage date 0..1 dateTime Date last changed publisher 0..1 string Name of the publisher (organization or individual) contact 0..* ContactDetail Contact details for the publisher <a href="StructureDefinition-athena-valueset-profile-definitions.html#ValueSet.description" title="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.">description 0..1 markdown Natural language description of the value set useContext 0..* UsageContext The context that the content is intended to support immutable 0..1 boolean Indicates whether or not any change to the content logical definition may occur purpose 0..1 markdown Why this value set is defined copyright 0..1 markdown Use and/or publishing restrictions compose 0..1 BackboneElement Content logical definition of the value set (CLD) lockedDate 0..1 date Fixed date for references with no specified version (transitive) include 0..* BackboneElement Include one or more codes from a code system or other value set(s) system S 1..1 uri The system the codes come from version 0..1 string Specific version of the code system referred to concept 0..* BackboneElement A concept defined in the system code S 1..1 code Code or expression from system display 0..1 string Text to display for this code for this value set in this valueset filter 0..* BackboneElement Select codes/concepts by their properties (including relationships) property S 1..1 code A property/filter defined by the code system op S 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists value S 1..1 string Code from the system, or regex criteria, or boolean value for exists exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets expansion 0..1 BackboneElement Used when the value set is "expanded" identifier S 1..1 uri Identifies the value set expansion (business identifier) timestamp S 1..1 dateTime Time ValueSet expansion happened total 0..1 integer Total number of codes in the expansion offset 0..1 integer Offset at which this resource starts parameter 0..* BackboneElement Parameter that controlled the expansion process name S 1..1 string Name as assigned by the client or server value[x] 0..1 string Value of the named parameter contains 0..* BackboneElement Codes in the value set system 0..1 uri System value for the code abstract 0..1 boolean If user cannot select this entry version 0..1 string Version in which this code/display is defined code 0..1 code Code - if blank, this is not a selectable code display 0..1 string User display for the concept contains 0..* See contains (ValueSet) Codes contained under this entry Documentation for this format
Defines constraints and extensions on the Binary resource as supported by Athena Products.
A set of codes drawn from one or more code systems
A value set specifies a set of codes drawn from one or more code systems.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
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.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this value set, represented as a URI (globally unique)
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.
Typically, this is used for values that can go in an HL7 v3 II data type.
Allows the value set to be referenced by a single globally unique identifier.
Additional identifier for the value set (business 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.
There may be multiple resource versions of the value set that have the same identifier.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
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.
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.
Name for this value set (computer friendly)
A free text natural language name describing the value set.
Allows filtering of value set instances that are appropriate (or not) for use.
Identify when/if the value set should be used.
Name for this value set (human friendly)
A short, descriptive, user-friendly title for the value set.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Allows filtering of value sets that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the value set. May also allow for contact.
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').
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.
Need to know when a value set was first legal for use or became withdrawn or replaced.
Name of the publisher (organization or individual)
The name of the individual or organization that published the value set.
May be a web site, an email address, a telephone number, etc.
Contacts to assist a user in finding and communicating with the publisher.
If there is no named individual, the telecom is for the organization as a whole.
Natural language description of the value set
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.
This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the value set is presumed to be the predominant language in the place the value set was created).The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.
Assist in searching for appropriate content.
The context that the content is intended to support
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.
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.
Intended jurisdiction for value set (if applicable)
A legal or geographic region in which the value set is intended to be used.
It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Indicates whether or not any change to the content logical definition may occur
If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
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.
Explains why this value set is needed and why it has been constrained as it has.
Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
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.
nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
It is not required to say whether this intent applies.
Content logical definition of the value set (CLD)
A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.
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.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Fixed date for references with no specified version (transitive)
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.
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.
Whether inactive codes are in the value set
Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems, e.g. LOINC, "deprecated" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active. The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).
Include one or more codes from a code system or other value set(s)
Include one or more codes from a code system.
See ''Coding.system'' for further documentation.
A value set include/exclude SHALL have a value set or a system
A value set with concepts or filters SHALL include a system
(concept.exists() or filter.exists()) implies system.exists()
not(exists(f:concept) or exists(f:filter)) or exists(f:system)
not(exists(f:concept)) or not(exists(f:filter))
An absolute URI which is the code system from which the selected codes come from.
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.
Specific version of the code system referred to
The version of the code system that the codes are selected from.
It is an error to include codes that are marked "abstract" in a value set that is used directly in a specification, but not an error to include an abstract code in a value set not destined for this use.
Specifies a concept to be included or excluded.
Expressions are allowed if defined by the underlying code system.
Specifies a code for the concept to be included or excluded.
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.
Text to display for this code for this value set in this valueset
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.
Additional representations for this concept
Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](http://hl7.org/fhir/R4/resource.html#language).
The language this designation is defined for.
In the absence of a language, the resource language applies.
A code that represents types of uses of designations.
If no use is provided, the designation can be assumed to be suitable for general display to a human user.
Details of how a designation would be used.
Select codes/concepts by their properties (including relationships)
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.
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.
A property/filter defined by the code system
A code that identifies a property defined in the code system.
= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
The kind of operation to perform as a part of the filter criteria.
Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
The kind of operation to perform as a part of a property based filter.
Code from the system, or regex criteria, or boolean value for exists
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.
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.
Select the contents included in this value set
Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.
The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](http://hl7.org/fhir/R4/snomedct.html#implicit), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.
Explicitly exclude codes from a code system or other value sets
Exclude one or more codes from the value set.
Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.
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.
Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).
Identifies the value set expansion (business identifier)
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.
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.
The time at which the expansion was produced by the expanding system.
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.
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.
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.
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).
Parameter that controlled the expansion process
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.
The names are assigned at the discretion of the server.
Name as assigned by the client or server
The codes that are contained in the value set expansion.
exists(f:code) or (f:abstract/@value = true())
An absolute URI which is the code system in which the code for this item in the expansion is defined.
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.
If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
The exact value of the version string is specified by the system from which the code is derived.
If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
If concept is inactive in the code system
If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).
This should only have a value if the concept is inactive.
Version in which this code/display is defined
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.
Code - if blank, this is not a selectable code
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.
The recommended display for this item in the expansion.
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.
Additional representations for this item
Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
The designations provided must be based on the value set and code system definitions.
Other codes and entries contained under this entry in the hierarchy.