Difference between revisions of "VocMnt-ValueSetRev/Create"
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===Creating a New Value Set=== | ===Creating a New Value Set=== | ||
| − | [[Image: | + | [[Image:VocMnt450a.gif||center||Element '''createValueSet''']] |
[[VocMnt-BallotStatus|'''ballotStatus''']] is the first element defined when creating a value set. As described above, it is optional except in the case when the '''vocabularyRevision.documentStatus''' is '''''Final''''', in which case all revisions have to be associated with a non- '''''Proposed''''' status. | [[VocMnt-BallotStatus|'''ballotStatus''']] is the first element defined when creating a value set. As described above, it is optional except in the case when the '''vocabularyRevision.documentStatus''' is '''''Final''''', in which case all revisions have to be associated with a non- '''''Proposed''''' status. | ||
| + | |||
| + | The '''<font color="#cc0000">valueSetMetaData</font>''' element provides a place to document a description of the changes that this value set creation entails. (The text may include xhtml markup, and is placed within the "valueSetMetaData" element.) further, the element has a single attribute. | ||
| + | |||
| + | [[Image:VocMnt476a.gif||center||Attribute of '''valueSetMetaData ''']] | ||
| + | |||
| + | {| class="wikitable" style="text-align:left" | ||
| + | !width="15%"| | ||
| + | ! | ||
| + | |- | ||
| + | !valign="top"|isImmutable | ||
| + | |If set, the value set definition will be declared '''immutable'''. | ||
| + | |} | ||
The '''description''' element is technically optional but '''virtually required by HL7 style and ballot guides'''. When present, it provides a description of the use and purpose of the value set. | The '''description''' element is technically optional but '''virtually required by HL7 style and ballot guides'''. When present, it provides a description of the use and purpose of the value set. | ||
| Line 32: | Line 44: | ||
|} | |} | ||
| − | + | {{{{{1|Show}}}Graphic|VocMnt471.gif|Example XML for '''createValueSet '''|The fragment in the example above creates a value set called “OrderableBeers” and assigns all of the codes from the BEERS code system to the set. It then creates a second value set called OrderableAles that is also drawn from the BEERS code system and assigns code 1001 (ALES) as the head code for the value set.}} | |
| − | |||
| − | |||
The '''underValueSet''' element allows the newly created value set to be added as nested element in an already existing value set. | The '''underValueSet''' element allows the newly created value set to be added as nested element in an already existing value set. | ||
Latest revision as of 21:46, 10 June 2014
Creating a New Value Set
ballotStatus is the first element defined when creating a value set. As described above, it is optional except in the case when the vocabularyRevision.documentStatus is Final, in which case all revisions have to be associated with a non- Proposed status.
The valueSetMetaData element provides a place to document a description of the changes that this value set creation entails. (The text may include xhtml markup, and is placed within the "valueSetMetaData" element.) further, the element has a single attribute.
| isImmutable | If set, the value set definition will be declared immutable. |
|---|
The description element is technically optional but virtually required by HL7 style and ballot guides. When present, it provides a description of the use and purpose of the value set.
| setName | The unique name of the value set |
|---|---|
| codeSystemName | The mnemonic for the code system associated with the value set (if any) |
| allCodes | If codeSystemName is supplied, this flag determines whether all of the codes in the code system are included in the value set or just selected codes. |
| headCode | It codeSystemName is supplied, this can be the concept code of the “head code” – the code that represents the entire value set. |
| headCodePrintName | A valid designation for the headCode. Optional, but validated if supplied. |
| asVocabularyDomain | <<Editor unsure of meaning. Does it mean "If true means that a concept domain should also be created."?>> |
The fragment in the example above creates a value set called “OrderableBeers” and assigns all of the codes from the BEERS code system to the set. It then creates a second value set called OrderableAles that is also drawn from the BEERS code system and assigns code 1001 (ALES) as the head code for the value set.
The underValueSet element allows the newly created value set to be added as nested element in an already existing value set.
| setName | The name of an existing value set to add this new value set under |
|---|---|
| addAsType | One of abstract or specializable. Abstract means that the head code (if any) of the new value set is not to be considered part of setName. Specializable means that the head code (if any) is to be included in setName. |
