Skip to end of metadata
Go to start of metadata

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

termactionadded to vocab glossary
Comment
7.1.4.2Version
this is version identifier - not version
7.1.4.3Name
is this the same as value set definition name - defined earlier in the document????
AllowedQualifiersno changeyes
poor definition
AllowedQualifiers RelationshipNameadded to new version of the documentyes

AreBaseQualifiersUnimitedno changeyes

CDLSyntaxReferenceno changeyes

codedescriptive and usage information have been added to the Vocabulary agreed definitionNOT UPDATED - TO BE DETERMINEDNOTE:  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 DETERMINEDpreviously this was CodeSystemID which it seems like it should still be it is not a definitoin of code system
CodeSystem AllowedRepresentationname updated, content updatedyes

CodeSystem DescriptiveNamename updated, content updatedyes

CodesystemConstraintParametersno changeyes
should be singlular?
content logical definitionno changeyes

concept property expressionno changeyes

concept property nameno changeyes

concept property valueno changeyes

DrawnFromCodeSystemno changeyes
poor definition - are you defining that this is the gorup of elements or that it is an indicator that this group of elements …...
example contentretiredyes

ExcludeContentno changeyes
poor definition
experimental value setname corrected otherwise no changeyes
poor grammar in the definition it can't replace the term in a sentence
ExpressionTypename modified, content updatedyes

immutablemodifiedyes
the second sentence of the definition moved to description as a two sentence definition is not permitted
IncludeHeadCodeno changeyes
poor definition
IncludeWithPropertyno changeyes
poor definition
IntersectionWithContentno changeyes
poor definition
MaximumMultiplicityno changeyes

MaximumMultiplicity for qualifiersadded to new version of the documentyes

MinimumMultiplicityno changeyes

MinimumMultiplicity for qualifiersadded to new version of the documentyes

RelationshipNameno changeyes

RelationshipTransversalno changeyes
poor definition
SortKey for qualifiersname updated, content updatedyes

TargetConceptsno changeyes

TargetConcepts for qualifiersname updated, content updatedyes

trusted value set expansion sourcecontent updatedyes

UnionWithContentadded to new version of the documentyes
poor definition
UsesCodeSystemPartitionname updated, content updatedyes

UsesCodeSystemSupplement
yes

value set definition
already there
no defintion in the document now???
Value set definition active statusname updated, content updatedyesold term retired
value set definition ActiveOnlyname updated, content updatedyesold term retired
value set definition activity status datename updated, content updatedyesold term retired
value set definition authorname updated, content updatedyesold term retired
value set definition change noteadded to new version of the documentyes
Note:  added as singular - change note
value set definition code system sourcename updated, content updatedyesold term retired
value set definition commentsname updated, content updatedyesold term retirednote:  definitions should be singular - I have left this as plural 
value set definition CommentStringname updated, content updatedyesold term retired
value set definition CommentTimeStampname updated, content updatedyesold term retired
value set definition content expressionadded to new version of the documentyes

value set definition created byname updated, content updatedyesold term retired
value set definition creation datename updated, content updatedyesold term retired
Value set definition expressionadded to new version of the documentyesold term retired
value set definition keywordname corrected otherwise no changeyesold term retired
value set definition LockedDatename updated, content updatedyesold term retired
value set definition namename corrected otherwise no changeyesValue 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 languagename corrected otherwise no changeyesValue 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 namingname corrected otherwise no changeyes
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 byname updated, content updatedyesold term retired
value set definition revision datename updated, content updatedyesold term retired
value set definition revision version identifiername updated, content updatedyesold term retired
value set definition source referencename corrected otherwise no changeyesold term retired
value set definition stewardname updated, content updatedyesold term retired
value set definition tracking identifiername updated, content updatedyesold term retired
value set definition typename updated, content updatedyesold term retired
value set definition URLname modified (was definitional) otherwise no changeyes

value set definition usename corrected otherwise no changeyesold term retired
value set definition version
yes
no definition found
value set definition version activity statusname updated, comment updated and image loadedyesold term retired
value set definition version identifierno changeyes

value set definition workflow statusname updated, content updatedyesold term retired
value set identifieradded to new version of the documentyesprevious definition retired
value set intellectual property informationname corrected otherwise no change.yesold term retired
value set perferred name indicatorno changeyes

value set scopeno changeyes

valueseREfIDno changeyes

VersionLockedDateadded to new version of the documentyes

VersionLockedStringadded to new version of the documentyes



HL7 Vocabulary Glossary as at Feb 2019

Glossary (list of all Terms) for the following Documents:HL7 Vocab Glossary
TermDefinition
AllowedQualifiersspecifies, 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 MinimumMultiplicitythe 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
AreBaseQualifiersUnlimitedindicates whether there are no constraints on qualifiers used in the types of Content Expressions
attributecharacteristic of an object or entity
cardinalitynumber of times a data element may repeat within an individual occurrence of an object view
CLDSyntaxReferencea link or identifiable name for the syntax used in the Content Logical Definition Content Expression.
codeA series of letters, numbers, or symbols assigned to one concept in a code system for the purposes of classification or identification
codespecific concept representation
code systeman organized, managed collection of codes, each of which has associated designations, meanings and in some cases relationships, properties or rules
CodeSystem AllowedRepresentationidentifies 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 DescriptiveNamehuman readable signifier for the Code System
CodeSystem UsesCodeSystemPartitionidentifies the partitions of the specified Code System that are included as part of the content.
CodeSystem UsesCodeSystemSupplementidentifies a collection of additional concept attributes for a Code System used as part of the Value Set Definition
CodeSystemContraintParametersscontains a set of constraints on the DrawnFromCodeSystem or ion the Concept Representations in that Code System
CodeSystemForExpansiongroup of elements identifying the Code System(s) that was used to create the Value Set Expansion Code Set
CodeSystemIDformal registered machine-processable identifier of the code system
conceptunitary mental representation of a real or abstract thing
concept identifierconcept representation that unambiguously represents and references the concept within the code system
concept property expressionregular expression against which the property value should be evaluated
concept property nameword or set of words to describe the concept property
concept property valuevalue for which the property should be checked
concept representationDepiction of a concept by a series of letters, numbers or symbols
content logical definitionformal representation used to determine the coded concept contents to be included in the Value Set Expansion Code Set
contextrelated conditions and situations that provide a useful understanding and meaning of a subject
data typean attribute that tells what kind of data a value can have
designationLanguage symbol concept representation for a concept that is intended to convey the concept meaning to a human being.
domainsphere of knowledge, influence or activity
DrawnFromCodeSystemgroup of elements identifying the Code System that applies for this portion of the Content Logical Definition
eventa situation considered to occur during a time interval
ExcludedContentidentifies content that is explicitly excluded.
experimental value setthis Value Set is created for educational or testing purposes, and is not intended for production use
ExpressionTypename or description of the language in which the expression is rendered.
extensional definitionspecification by enumeration of the individual members of a set 
extensional value set definitionspecification by enumeration of a uniquely identifiable set of valid values, consisting of concept representations (codes) drawn from one or more code systems.
immutableproperty indicating that no change to the Content Logical Definition may occur.
IncludeHeadCodeindicates that the code is included in the content.
IncludeWithPropertyindicates that codes with certain properties in the Code System are part of the Value Set Expansion Code Set.
instancea specific occurrence of a thing
interactionsingle, one-way information flow that supports a communication requirement expressed in a scenario
IntersectionWithContentidentifies Content Expressions that all concepts/codes must also match to be included
MaximumMultiplicitythe maximum number of the specified relationships allowed
MaximumMultiplicity for Qualifiersmaximum number of qualifiers of this type that may be provided
MinimumMultiplicitythe minimum number of the specified relationships allowed
MinimumMultiplicity for Qualifiersthe minimum number of the qualifiers allowed
post-coordinated expressionrepresentation of meaning using a combination of two or more pre-coordinated concept
Qualifying Concept RelationshipNameword or words to identify the type of relationshp from the base concept to the qualifying concept
relationship based ExpressionTypename or description of the language in which the expression is rendered
RelationshipNameword or set of words to describe the relationship used for traversal to find related codes. 
RelationshipTraversalidentifies which codes related by the specified relationship should be included
SortKey for Qualifiersqualifier ordinal position
SortKey for Value Set Expansion Code Setindicates the relative order in which the listed code should be presented
sufficientindicates that a Value Set Definition generates an Expansion Code Set that fully implements the Value Set Definition scope
TargetConceptsan expression that defines the set of Concept Representations that are allowed targets of the named relationship.
TargetConcepts for qualifiersidentifies the set of constraints on qualifer codes
terminologystructured, human and machine-readable representation of concepts
trusted value set expansion file sourcelist of references to trusted Value Set Expansion Code Sets
UnionWithContentIdentifies one or mor Content Definiing Elements such that content from any of them is considered to be part of the Content Defining Element
UsesCodeSystemPartitionidentifies the partitions of the specified Code System that are included as part of the content
UsesCodeSystemSupplementidentifies a collection of additional concept attributes for the Code System used as part of the Value Set Definition.
value domainThe range of values permitted in a given data element.
Value Setlabel for both the value set definition and value set expansion
value set change notesannotation of revision
Value Set Definitiondescription of the set of concept representations (usually codes) that are intended for use
value set definition ActiveOnlyInstruction to include only ACTIVE Concept Representations in the Value Set Expansion Code Set
value set definition activity statusthe release and/or usability state
value set definition activity status datethe date when the associated Value Set Definition Version activity status is in effect.
value set definition authorthe entity or set of entities that create and may modify the Value Set Definition content.
value set definition change noteannotation of revision
value set definition code system sourcethe Code System(s) identifiers explicitly referenced by the Value Set
value set definition commentshuman-specified notes and other documentation
value set definition CommentStringunrestricted field of remarks or other text
value set definition CommentTimeStampdate/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 byname of the user entity that created this Value Set Definition
value set definition creation datewhen the Value Set Definition was originally created
Value Set Definition Expressionthe string expression against which to evaluate the code symbols
value set definition keyworda word or phrase that captures a key aspect of a Value Set Definition
value set definition LockedDatethe 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 nameword or set of words by which the Value Set is known, addressed or referenced
value set definition name languagecode to indicate the system of communication used by a particular country or community in which the name is represented
value set definition namingthe human-readable monikers of this Value Set Definition
value set definition revised byname of user entity responsible for the revision
value set definition revision datedate and time when an element was changed in some way
value set definition revision version identifierthe 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 stewardthe entity that is responsible for the content of the Value Set Definition
value set definition tracking identifieridentifier for the changes for each revision
value set definition typecharacterization of the Value Set Definition
value set definition URLa web pointer to where the Value Set Definition may be located
value set definition usethe manner in which the Value Set Definition will be employed or applied
value set definition version activity statusrelease and / or usability state
value set definition version identifiera unique string labeling a Value Set Definition Version
value set definition workflow statusthe state of development of the Value Set Definition while in a single Activity Status.
value set identifierglobally unique string identifying this value set
value set intellectual property informationpublishing restrictions for the Value Set Definition metadata
value set preferred name indicatoridentifies the single preferred name for the “Name Language”
value set reference namehuman readable string associasted with the Referenced Value Set Definition
value set scopetextual 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
ValueSetRefIdthe 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
VersionLockedStringa string that constrains the associated Code System to the single published Code System version identified
Vocabularysum or stock of words employed by a language, group, individual work or in a field of knowledge
Vocabulary Bindingassociation between a coded element and the set of permissable values that may be carried in that element
vocabulary declarationmetamodel element in a coded data type that references the concept domain or value set


Documents

Updated Vocabulary glossary control sheet after VSD loading:   




Link to Online Glossary


www.skmtglossary.org- the location of International Standards Glossary  




HL7 Vocabulary content is in the document HL7 Vocabulary Glossary.


Education Material


  • No labels

1 Comment

  1. Next Terms to be discussed (as at July 2018

    Value SetUniquely identifiable set of 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 codesretire
    Value setuniquely identifiable set of valid values, consisting of concept representations (codes) drawn from one or more code systems which can be resolved at a given point in time to an exact set of codesSuggest
    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.
    This should be discussed on a call as there is now a concept of a value set containing the definition AND the expansion.
    Value Setuniquely identifiable set of valid concept identifiers, where any concept identifier in a coded element can be tested to determine whether it is a member of the Value Set at a specific point in timeretire


    Vocabulary Binding

    Vocabulary Bindingmechanism of identifying specific codes to be used to express the semantics of coded model elements in HL7 information models or coded data type properties
    ? Take to Binding call
    Vocabulary BindingThe association between a coded element and the set of legal values that may be carried in that element 

    Bindingprocedure to limit bias by preventing subjects and/or study personnel from identifying which treatments or procedures are administered, or from learning the results of tests and measures undertaken as part of a clinical investigation























    Vocabulary Bindingthe mechanism of identifying specific codes to be used to express the semantics of coded model elements in HL7 informaton models or coded data typesthe mechanism of identifying specific codes to be used to express the semantics of coded model elements in information models or coded data type properties

    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

    vocabulary declarationThe Vocabulary Declaration identifies the constraints on the coded expressions that can be used as well as the vocabulary conformance expectations for implementers of the data element.
    vocabulary declarationidentified constraints on the coded expression that can be used, as well as the vocabulary conformance expectations, for implementers of the data