Difference between revisions of "VocMnt-CodeSysRev/ChangeCodeDesc"
| Line 4: | Line 4: | ||
The description of a concept code may be added, modified or removed using the '''updateCodeDescription''' element. | The description of a concept code may be added, modified or removed using the '''updateCodeDescription''' element. | ||
| − | [[Image: | + | [[Image:VocMnt340a.gif||center||Element '''updateCodeDescription''']] |
As with all updates, '''updateCodeDescription''' can have its own [[VocMnt-BallotStatus|'''ballotStatus''']] if needed to reflect special cases. It has an optional '''oldDescription''' element that can contain the description that is being changed and a '''newDescription''' element that contains the revised description or can be empty if the description is to be completely removed. If present, the '''oldDescription''' will be validated against the database before the change is performed. | As with all updates, '''updateCodeDescription''' can have its own [[VocMnt-BallotStatus|'''ballotStatus''']] if needed to reflect special cases. It has an optional '''oldDescription''' element that can contain the description that is being changed and a '''newDescription''' element that contains the revised description or can be empty if the description is to be completely removed. If present, the '''oldDescription''' will be validated against the database before the change is performed. | ||
| Line 21: | Line 21: | ||
|} | |} | ||
{{{{{1|Show}}}Graphic|VocMnt361.gif|Example XML for '''updateCodeDescription'''|The example above removes the second sentence from the “Light Ale” description. Note that the preferred name is “Light Ale” rather than “LIGHT ALE” because of an update that occurred earlier in both this document and the actual XML update source.}} | {{{{{1|Show}}}Graphic|VocMnt361.gif|Example XML for '''updateCodeDescription'''|The example above removes the second sentence from the “Light Ale” description. Note that the preferred name is “Light Ale” rather than “LIGHT ALE” because of an update that occurred earlier in both this document and the actual XML update source.}} | ||
| + | ====<font color="#bb0000">Updating Property on a Concept Code</font>==== | ||
| + | Once a property has been added to a coded concept, that property may be updated using the '''updatePropertyOnCode'''' element. | ||
| + | [[Image:VocMnt205a.gif||center||Element '''updatePropertyOnCode''']] | ||
| + | |||
| + | As with other property setting elements, the value to which the property should be updated is documented as the content of a child '''property''' element. | ||
| + | |||
| + | [[Image:VocMnt196a.gif||center||Attributes of '''updatePropertyOnCode''']] | ||
| + | |||
| + | {| class="wikitable" style="text-align:left" | ||
| + | !width="15%"| | ||
| + | ! | ||
| + | |- | ||
| + | !valign="top"|conceptCode | ||
| + | |The concept code to which the property is attached | ||
| + | |- | ||
| + | !valign="top"|propertyId | ||
| + | |The identifier (name) of the property to be updated. | ||
| + | |} | ||
| + | ====<font color="#bb0000">Removing Properties from a Concept Code</font>==== | ||
| + | A property that has been added to a coded concept may be removed using the '''removePropertyFromCode''' element. | ||
| + | [[Image:VocMnt295a.gif||center||Element '''removePropertyFromCode''']] | ||
| + | |||
| + | [[Image:VocMnt196a.gif||center||Attributes of '''removePropertyFromCode''']] | ||
| + | |||
| + | {| class="wikitable" style="text-align:left" | ||
| + | !width="15%"| | ||
| + | ! | ||
| + | |- | ||
| + | !valign="top"|conceptCode | ||
| + | |The concept code to which the property is attached | ||
| + | |- | ||
| + | !valign="top"|propertyId | ||
| + | |The identifier (name) of the property to be removed. | ||
| + | |} | ||
Revision as of 21:18, 10 June 2014
Changing the Description of a Concept Code
The description of a concept code may be added, modified or removed using the updateCodeDescription element.
As with all updates, updateCodeDescription can have its own ballotStatus if needed to reflect special cases. It has an optional oldDescription element that can contain the description that is being changed and a newDescription element that contains the revised description or can be empty if the description is to be completely removed. If present, the oldDescription will be validated against the database before the change is performed.
| conceptCode | The concept code that the change is being applied to |
|---|---|
| conceptName | A valid designation for the concept code. Optional, but will be validated if supplied. |
The example above removes the second sentence from the “Light Ale” description. Note that the preferred name is “Light Ale” rather than “LIGHT ALE” because of an update that occurred earlier in both this document and the actual XML update source.
Updating Property on a Concept Code
Once a property has been added to a coded concept, that property may be updated using the updatePropertyOnCode' element.
As with other property setting elements, the value to which the property should be updated is documented as the content of a child property element.
| conceptCode | The concept code to which the property is attached |
|---|---|
| propertyId | The identifier (name) of the property to be updated. |
Removing Properties from a Concept Code
A property that has been added to a coded concept may be removed using the removePropertyFromCode element.
| conceptCode | The concept code to which the property is attached |
|---|---|
| propertyId | The identifier (name) of the property to be removed. |
