Vocabulary Revisions Proposal
A Vocabulary Revision represents a related collection of updates to one or more code systems, value sets and/or concept domains. Each vocabulary revision proposal comes from a single HL7 committee and is represented by one primary contact person. The VocabularyRevision element has to be the outermost (first) element in any vocabulary submission.
A VocabularyRevision always begins with an editDescription element that describes the intent and purpose of the proposal. There are several textual elements in editDescription as shown below. The actual description should be recorded in the description element.
The attributes of the editDescription are listed below:
|creationDate||when the document was first created (format: yyyy-mm-dd).|
|proposalId||id should be unique within the committee submitting it. A committee id will be concatenated to get a "unique" id.|
|primaryContact||the name of the person responsible for the document|
|committee|||the committee identifier primarily responsible for the changes|
|documentStatus|||[Not exposed in application, and should be] see table below:|
|Proposed||The document is in the initial stages|
|Submitted||The document has been submitted for review by the appropriate committees.|
|Reviewed||The document has been reviewed by the appropriate committees and is awaiting harmonization.|
|Harmonized||The document has been reviewed and voted on by the RIM Harmonization Committee|
|Final||The document has been recorded in the official RIM database and can undergo no further changes.|
|Rejected||The document was not accepted at some stage in the process.|
The tools used to update the actual vocabulary tables won’t process Rejected status documents. In addition, warnings will be generated if Harmonized or Final documents contain Proposed ballotStatus action entries (described below).
Final and Harmonized submissions must also supply OID’s for all new code system registrations.
The sample above describes a new edit created on September 25, 2007 by Woody Beeler for the Methodology & Modeling committee.
NOTE: the application will not process a proposal that has no content in the <description/> element of editDescription.