SCOPE
To achieve a single, harmonised glossary for HL7, where each term has ONE accepted definition in HL7.
Initial work undertaken and HL7 Vocabulary WG Glossary established
Current Activity and Status
- HL7 total glossary
- Retiring Green Book
- Procedures for WGs to follow.
- Publication
Glossary Issues and status post VSD load
| term | action | added to vocab glossary | Comment | |
| 7.1.4.2 | Version | this is version identifier - not version | ||
| 7.1.4.3 | Name | is this the same as value set definition name - defined earlier in the document???? | ||
| AllowedQualifiers | no change | yes | poor definition | |
| AllowedQualifiers RelationshipName | added to new version of the document | yes | ||
| AreBaseQualifiersUnimited | no change | yes | ||
| CDLSyntaxReference | no change | yes | ||
| code | descriptive and usage information have been added to the Vocabulary agreed definition | NOT UPDATED - TO BE DETERMINED | NOTE: THIS: IS NOT THE DEFINITION AGREED FOR USE BY VOCABULARY - A series of letters, numbers, or symbols assigned to one concept in a code system for the purpose of classification or identification | |
| CodeSystem | NOT UPDATED - TO BE DETERMINED | previously this was CodeSystemID which it seems like it should still be it is not a definitoin of code system | ||
| CodeSystem AllowedRepresentation | name updated, content updated | yes | ||
| CodeSystem DescriptiveName | name updated, content updated | yes | ||
| CodesystemConstraintParameters | no change | yes | should be singlular? | |
| content logical definition | no change | yes | ||
| concept property expression | no change | yes | ||
| concept property name | no change | yes | ||
| concept property value | no change | yes | ||
| DrawnFromCodeSystem | no change | yes | poor definition - are you defining that this is the gorup of elements or that it is an indicator that this group of elements …... | |
| example content | retired | yes | ||
| ExcludeContent | no change | yes | poor definition | |
| experimental value set | name corrected otherwise no change | yes | poor grammar in the definition it can't replace the term in a sentence | |
| ExpressionType | name modified, content updated | yes | ||
| immutable | modified | yes | the second sentence of the definition moved to description as a two sentence definition is not permitted | |
| IncludeHeadCode | no change | yes | poor definition | |
| IncludeWithProperty | no change | yes | poor definition | |
| IntersectionWithContent | no change | yes | poor definition | |
| MaximumMultiplicity | no change | yes | ||
| MaximumMultiplicity for qualifiers | added to new version of the document | yes | ||
| MinimumMultiplicity | no change | yes | ||
| MinimumMultiplicity for qualifiers | added to new version of the document | yes | ||
| RelationshipName | no change | yes | ||
| RelationshipTransversal | no change | yes | poor definition | |
| SortKey for qualifiers | name updated, content updated | yes | ||
| TargetConcepts | no change | yes | ||
| TargetConcepts for qualifiers | name updated, content updated | yes | ||
| trusted value set expansion source | content updated | yes | ||
| UnionWithContent | added to new version of the document | yes | poor definition | |
| UsesCodeSystemPartition | name updated, content updated | yes | ||
| UsesCodeSystemSupplement | yes | |||
| value set definition | already there | no defintion in the document now??? | ||
| Value set definition active status | name updated, content updated | yes | old term retired | |
| value set definition ActiveOnly | name updated, content updated | yes | old term retired | |
| value set definition activity status date | name updated, content updated | yes | old term retired | |
| value set definition author | name updated, content updated | yes | old term retired | |
| value set definition change note | added to new version of the document | yes | Note: added as singular - change note | |
| value set definition code system source | name updated, content updated | yes | old term retired | |
| value set definition comments | name updated, content updated | yes | old term retired | note: definitions should be singular - I have left this as plural |
| value set definition CommentString | name updated, content updated | yes | old term retired | |
| value set definition CommentTimeStamp | name updated, content updated | yes | old term retired | |
| value set definition content expression | added to new version of the document | yes | ||
| value set definition created by | name updated, content updated | yes | old term retired | |
| value set definition creation date | name updated, content updated | yes | old term retired | |
| Value set definition expression | added to new version of the document | yes | old term retired | |
| value set definition keyword | name corrected otherwise no change | yes | old term retired | |
| value set definition LockedDate | name updated, content updated | yes | old term retired | |
| value set definition name | name corrected otherwise no change | yes | Value set definition added to the title 'Name' documented in the standard as it is under value set defintion - non definitional elements. This is not the definition of a name per se it is a definition of a value set definition name | |
| value set definition name language | name corrected otherwise no change | yes | Value set definition added to the title 'Name' documented in the standard as it is under value set defintion - non definitional elements. This is not the definition of a name per se it is a definition of a value set definition name | |
| value set definition naming | name corrected otherwise no change | yes | NOTE: you have defined a verb - the process of naming - but your defiition is of a noun Suggest modification of the definition. The document can be modified if desired but we could just agree to modify in SKMT ?? | |
| value set definition revised by | name updated, content updated | yes | old term retired | |
| value set definition revision date | name updated, content updated | yes | old term retired | |
| value set definition revision version identifier | name updated, content updated | yes | old term retired | |
| value set definition source reference | name corrected otherwise no change | yes | old term retired | |
| value set definition steward | name updated, content updated | yes | old term retired | |
| value set definition tracking identifier | name updated, content updated | yes | old term retired | |
| value set definition type | name updated, content updated | yes | old term retired | |
| value set definition URL | name modified (was definitional) otherwise no change | yes | ||
| value set definition use | name corrected otherwise no change | yes | old term retired | |
| value set definition version | yes | no definition found | ||
| value set definition version activity status | name updated, comment updated and image loaded | yes | old term retired | |
| value set definition version identifier | no change | yes | ||
| value set definition workflow status | name updated, content updated | yes | old term retired | |
| value set identifier | added to new version of the document | yes | previous definition retired | |
| value set intellectual property information | name corrected otherwise no change. | yes | old term retired | |
| value set perferred name indicator | no change | yes | ||
| value set scope | no change | yes | ||
| valueseREfID | no change | yes | ||
| VersionLockedDate | added to new version of the document | yes | ||
| VersionLockedString | added to new version of the document | yes | ||
HL7 Vocabulary Glossary as at Feb 2019
| Glossary (list of all Terms) for the following Documents: | HL7 Vocab Glossary |
| Term | Definition |
| AllowedQualifiers | specifies, through the identifgied constraints, a subset of allowed concepts based on matching the specified constraints. |
| AllowedQualifiers MaximumMultiplicity | ​maximum number of qualifiers of this type that may be provided |
| AllowedQualifiers MinimumMultiplicity | the minimum number of the qualifiers allowed |
| AllowedQualifiers RelationshipName | ​word or words to identify the type of relationship from the base concept to the qualifying concept |
| AreBaseQualifiersUnlimited | indicates whether there are no constraints on qualifiers used in the types of Content Expressions |
| attribute | characteristic of an object or entity |
| cardinality | number of times a data element may repeat within an individual occurrence of an object view |
| CLDSyntaxReference | a link or identifiable name for the syntax used in the Content Logical Definition Content Expression. |
| code | A series of letters, numbers, or symbols assigned to one concept in a code system for the purposes of classification or identification |
| code | specific concept representation |
| code system | an organized, managed collection of codes, each of which has associated designations, meanings and in some cases relationships, properties or rules |
| CodeSystem AllowedRepresentation | identifies constraints on the Concept Representations to be populated in the Value Set Expansion Code Set when the Code System has multiple Concept Representations available. |
| CodeSystem DescriptiveName | human readable signifier for the Code System |
| CodeSystem UsesCodeSystemPartition | identifies the partitions of the specified Code System that are included as part of the content. |
| CodeSystem UsesCodeSystemSupplement | identifies a collection of additional concept attributes for a Code System used as part of the Value Set Definition |
| CodeSystemContraintParameters | scontains a set of constraints on the DrawnFromCodeSystem or ion the Concept Representations in that Code System |
| CodeSystemForExpansion | group of elements identifying the Code System(s) that was used to create the Value Set Expansion Code Set |
| CodeSystemID | formal registered machine-processable identifier of the code system |
| concept | unitary mental representation of a real or abstract thing |
| concept identifier | concept representation that unambiguously represents and references the concept within the code system |
| concept property expression | regular expression against which the property value should be evaluated |
| concept property name | word or set of words to describe the concept property |
| concept property value | value for which the property should be checked |
| concept representation | Depiction of a concept by a series of letters, numbers or symbols |
| content logical definition | formal representation used to determine the coded concept contents to be included in the Value Set Expansion Code Set |
| context | related conditions and situations that provide a useful understanding and meaning of a subject |
| data type | an attribute that tells what kind of data a value can have |
| designation | Language symbol concept representation for a concept that is intended to convey the concept meaning to a human being. |
| domain | sphere of knowledge, influence or activity |
| DrawnFromCodeSystem | group of elements identifying the Code System that applies for this portion of the Content Logical Definition |
| event | a situation considered to occur during a time interval |
| ExcludedContent | identifies content that is explicitly excluded. |
| experimental value set | this Value Set is created for educational or testing purposes, and is not intended for production use |
| ExpressionType | name or description of the language in which the expression is rendered. |
| extensional definition | specification by enumeration of the individual members of a set |
| extensional value set definition | specification by enumeration of a uniquely identifiable set of valid values, consisting of concept representations (codes) drawn from one or more code systems. |
| immutable | property indicating that no change to the Content Logical Definition may occur. |
| IncludeHeadCode | indicates that the code is included in the content. |
| IncludeWithProperty | indicates that codes with certain properties in the Code System are part of the Value Set Expansion Code Set. |
| instance | a specific occurrence of a thing |
| interaction | single, one-way information flow that supports a communication requirement expressed in a scenario |
| IntersectionWithContent | identifies Content Expressions that all concepts/codes must also match to be included |
| MaximumMultiplicity | the maximum number of the specified relationships allowed |
| MaximumMultiplicity for Qualifiers | maximum number of qualifiers of this type that may be provided |
| MinimumMultiplicity | the minimum number of the specified relationships allowed |
| MinimumMultiplicity for Qualifiers | the minimum number of the qualifiers allowed |
| post-coordinated expression | representation of meaning using a combination of two or more pre-coordinated concept |
| Qualifying Concept RelationshipName | word or words to identify the type of relationshp from the base concept to the qualifying concept |
| relationship based ExpressionType | name or description of the language in which the expression is rendered |
| RelationshipName | word or set of words to describe the relationship used for traversal to find related codes. |
| RelationshipTraversal | identifies which codes related by the specified relationship should be included |
| SortKey for Qualifiers | qualifier ordinal position |
| SortKey for Value Set Expansion Code Set | indicates the relative order in which the listed code should be presented |
| sufficient | indicates that a Value Set Definition generates an Expansion Code Set that fully implements the Value Set Definition scope |
| TargetConcepts | an expression that defines the set of Concept Representations that are allowed targets of the named relationship. |
| TargetConcepts for qualifiers | identifies the set of constraints on qualifer codes |
| terminology | structured, human and machine-readable representation of concepts |
| trusted value set expansion file source | list of references to trusted Value Set Expansion Code Sets |
| UnionWithContent | Identifies one or mor Content Definiing Elements such that content from any of them is considered to be part of the Content Defining Element |
| UsesCodeSystemPartition | identifies the partitions of the specified Code System that are included as part of the content |
| UsesCodeSystemSupplement | identifies a collection of additional concept attributes for the Code System used as part of the Value Set Definition. |
| value domain | The range of values permitted in a given data element. |
| Value Set | label for both the value set definition and value set expansion |
| value set change notes | annotation of revision |
| Value Set Definition | description of the set of concept representations (usually codes) that are intended for use |
| value set definition ActiveOnly | Instruction to include only ACTIVE Concept Representations in the Value Set Expansion Code Set |
| value set definition activity status | the release and/or usability state |
| value set definition activity status date | the date when the associated Value Set Definition Version activity status is in effect. |
| value set definition author | the entity or set of entities that create and may modify the Value Set Definition content. |
| value set definition change note | annotation of revision |
| value set definition code system source | the Code System(s) identifiers explicitly referenced by the Value Set |
| value set definition comments | human-specified notes and other documentation |
| value set definition CommentString | unrestricted field of remarks or other text |
| value set definition CommentTimeStamp | date/time when the comment was created |
| value set definition content expression | ​how to identify a Value Set Expansion Code Set from identified Code Systems that falls within the meaning described in the Scope element |
| value set definition created by | name of the user entity that created this Value Set Definition |
| value set definition creation date | when the Value Set Definition was originally created |
| Value Set Definition Expression | the string expression against which to evaluate the code symbols |
| value set definition keyword | a word or phrase that captures a key aspect of a Value Set Definition |
| value set definition LockedDate | the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the Content Expression that are not already tied to a specific version. |
| value set definition name | word or set of words by which the Value Set is known, addressed or referenced |
| value set definition name language | code to indicate the system of communication used by a particular country or community in which the name is represented |
| value set definition naming | the human-readable monikers of this Value Set Definition |
| value set definition revised by | name of user entity responsible for the revision |
| value set definition revision date | date and time when an element was changed in some way |
| value set definition revision version identifier | the Value Set Definition Version Identifier to which the history item applies |
| value set definition source reference | ​reference to prior work used as a basis in authoring of this Value Set |
| value set definition steward | the entity that is responsible for the content of the Value Set Definition |
| value set definition tracking identifier | identifier for the changes for each revision |
| value set definition type | characterization of the Value Set Definition |
| value set definition URL | a web pointer to where the Value Set Definition may be located |
| value set definition use | the manner in which the Value Set Definition will be employed or applied |
| value set definition version activity status | release and / or usability state |
| value set definition version identifier | a unique string labeling a Value Set Definition Version |
| value set definition workflow status | the state of development of the Value Set Definition while in a single Activity Status. |
| value set identifier | globally unique string identifying this value set |
| value set intellectual property information | publishing restrictions for the Value Set Definition metadata |
| value set preferred name indicator | identifies the single preferred name for the “Name Language” |
| value set reference name | human readable string associasted with the Referenced Value Set Definition |
| value set scope | textual description of the span of meanings for concepts to be included within the Value Set Expansion Code Set including the intended use and limitations of the Value Set |
| ValueSetRefId | the unique identifier of the referenced Value Set Definition. |
| VersionLockedDate | ​a dateTime that constrains the associated code system to the single published Code System version that is current as of that dateTime |
| VersionLockedString | a string that constrains the associated Code System to the single published Code System version identified |
| Vocabulary | sum or stock of words employed by a language, group, individual work or in a field of knowledge |
| Vocabulary Binding | association between a coded element and the set of permissable values that may be carried in that element |
| vocabulary declaration | metamodel element in a coded data type that references the concept domain or value set |
Documents
Updated Vocabulary glossary control sheet after VSD loading:
www.skmtglossary.org- the location of International Standards Glossary
HL7 Vocabulary content is in the document HL7 Vocabulary Glossary.
Education Material
1 Comment
Heather Grain
Next Terms to be discussed (as at July 2018
uniquely identifiable set of valid values, consisting of concept representations drawn from one or more code systems which can be resolved at a given point in time to an exact set of code
A concept identifier in a Value Set may be a single concept code or a post-coordinated expression of a combination of codes. Value Sets exist to constrain the permissible content for a particular use, e.g. for use in analysis, display to a user, etc. For HL7, value sets constrain the permissible content for a coded element in an HL7 information model or data type specification.
Vocabulary Binding
Note: this association is between the coded element and the set of legal values that may be carried in that element. This concept is used extensively in HL7 messaging.
Vocabulary declaration