This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

VocMnt-ValueSetRev/AddCode

From HL7Wiki
Jump to navigation Jump to search

Adding Concept Codes to a Value Set

A list of concept codes may be added to a newly created value set as well as a previously existing value set.

Element addCodesToValueSet

The first element, ballotStatus, is optional. If supplied, it overrides any other applicable ballot status settings. Each codeAddition entry adds a concept code to the current value set. The order of the codeAddition entries is not important. A value set must have had a code system assigned to it in order to add individual concept codes.

Attributes of codeAddition
conceptCode The concept code to be added to the value set.
conceptName A valid designation for the concept code. Optional, but validated if supplied
relationship An optional relationship code. If present, it indicates that codes that are “children” of conceptCode are to be included in the value set as well. If omitted, only conceptCode itself is included. Note that hasSubtype is the official subsumption relationship.
relInclusion Indicates which of the related codes are to be included. Applies only if relationship is supplied. (See table below)
relInclusion Values
relInclusion Meaning
inclusive conceptCode and all of its direct and indirect “children” are included in the value set.
exclusive All of the direct and indirect “children” of conceptCode are included, but not conceptCode itself.
leafOnly Only the “leaf” descendants of conceptCode are to be included in the value set.
Example XML for addCodeToValueSet

The above example adds concept codes 1002, 1003 and 1004 to the OrderableAles value set.

Example XML for valueSetRevision with a specified relationship

The above example adds all of the children of the “ALES” node to the “SpecificAles” value set. Note that this is subtly different than the preceding example. In the first example, codes 1001, 1002, 1003 and 1004 are the only members of the OrderableAles value set, even if new types of ales are added to the code system. The second example creates exactly the same set to start with, but would automatically acquire new members were new children added to the 1001 (ALES) node.