Vocabulary Maintenance Language (Domain Revision)

From HL7Wiki
Jump to navigation Jump to search
Introduction   Proposal   Code System   Value Set   Domain   Properties   Appendices    

ReviseDomains ··· CreateDomains · (Re)defineDomain · RenameDomain · MoveDomain · DeleteDomain 

Concept Domain Revision

[Not fully exposed in application]

A concept domain represents an abstract conceptual space that can be associated with RIM-derived coded attributes. A concept domain can be represented by one or more value sets, where each associated value set applies in a given context. Further, sub-sets of concept domains may, themselves, be represented as concept domains in a parent-child semantic hierarchy. The set of operations that can be made on concept domains includes: create, define (or redefine), rename, move (in the hierarchy) and delete, as indicated below:

Element vocabularyDomainRevision -- Revising Concept Domains

Creating Concept Domains

[Exposed under VS in application]

The vast majority of the concept domains will be created during the RIM modeling process. The following operation can be used in cases where the domain doesn’t already exist in the RIM model.

Element createVocabularyDomain

The creation of a new domain needs to be voted upon, therefore createVocabularyDomain has an optional ballotStatus element. The description is technically optional, but is virtually required by HL7's style and balloting guides. It provides a description of the concept domain. createVocabularyDomain has the following attributes:

Attributes of createVocabularyDomain
vocabularyDomain The name of the new concept domain to be created
restrictsDomain The name of the parent concept domain (optional).
Example XML for createVocabularyDomain

The example above creates two concept domains – OrderableBeers and OrderableAles. OrderableAles is defined as a proper subset (restriction or constraint) on OrderableBeers.

Jump to top of page

Define or Redefine Concept Domain

[Not exposed in application]

A new or revised definition can be assigned to a concept domain with the defineVocabularyDomain element.

Element defineVocabularyDomain

As with all updates, defineVocabularyDomain can have its own ballotStatus if needed to reflect special cases. It has a newDescription element that contains the revised description or can be empty if the description is to be completely removed. defineVocabularyDomain has a single attribute:

Attribute of defineVocabularyDomain
vocabularyDomain The name of the concept domain to be (re)defined.
Jump to top of page

Rename Concept Domain

[Not exposed in application]

A new name can be assigned to a concept domain with the renameVocabularyDomain element.

Element renameVocabularyDomain

As with all updates, renameVocabularyDomain can have its own ballotStatus if needed to reflect special cases. renameVocaabularyDomain has two attributes:

Attributes of renameVocabularyDomain
vocabularyDomain The current name of the concept domain to be (re)defined.
newDomainName The new name of the concept domain.
Jump to top of page

Move Concept Domain

[Not exposed in application]

A concept domain can be moved within the domain hierarchy – made a child of another domain, made a child of a different domain than previously, or removed from under its parent -- using the moveVocabularyDomain element.

Element moveVocabularyDomain

As with all updates, moveVocabularyDomain can have its own ballotStatus if needed to reflect special cases. moveVocaabularyDomain has three attributes:

Attributes of moveVocabularyDomain
vocabularyDomain The name of the concept domain being moved.
fromDomain The current direct parent of the concept domain, if any. This attribute should be omitted if the concept domain doesn’t currently occur under any other node.
toDomain The new parent of the concept domain. If omitted, the concept domain no longer has a parent in the domain hierarchy.
Jump to top of page

Delete Concept Domain

[Not exposed in application]

A concept domain can be deleted from the set of HL7 domains using the moveVocabularyDomain element.

Element deleteVocabularyDomain

As with all updates, moveVocabularyDomain can have its own ballotStatus if needed to reflect special cases. moveVocaabularyDomain has one attributes:

Attribute of deleteVocabularyDomain
vocabularyDomain The name of the concept domain to be deleted.
Jump to top of page

Not exposed in application
Capability that is listed as Not exposed in application are functions that are not (as of this writing) supported by the Harmonization Tooling application.
Not fully exposed in application
Capability that is listed as Not fully exposed in application represents a set of capabilities, some, but not all of which is implemented in the Harmonization Tooling application.
Exposed under VS in application
Code System capability that is listed as Exposed under VS in application are functions that cannot be invoked directly, but that are present in processing value set changes on Value Sets whose Code System is established by a previous binding
Concept Domain
The term Concept Domain was formally adopted by the HL7 Vocabulary Technical Committee as the name for an abstract conceptual space that may be represented by (bound to) a set of concepts found in one or more specific code systems. Previous to this adoption, the preferred name for the same abstract conceptual space was Vocabulary Domain. In editing this document, the term "vocabulary domain" has been replaced with "concept domain", except where the term is part of the XML schema. In order to avoid "breaking" software tools that were built to the previous version of the schema, the XML attribute and element names retain the phrase "vocabularyDomain".