|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| | + | ==Manual Changes for Release 1.1.0== |
| | + | Changes to the Editor in Release 1.1.0 changed a number of the screens and caused some of the error messages to be retired. In order to allow the manual to be used for both Release 1.0 and 1.1.0, the manual has, in most cases, been edited leaving the '''old content''' in, but "striking it out" (<s>like this</s>) and annotating all figures that show older, no longer valid screens. |
| | + | |
| | + | These changes were made October 21, 2007 when the new Editor was released. The '''old content''' will be removed from the manual in a couple of weeks. |
| | ==Introduction== | | ==Introduction== |
| | This is the initial pass at creating a manual for the Vocabulary '''Harmonization Editor''' tool that has been developed for HL7. This application permits: | | This is the initial pass at creating a manual for the Vocabulary '''Harmonization Editor''' tool that has been developed for HL7. This application permits: |
| Line 11: |
Line 15: |
| | #Code to allow a user to interactively create and update (proposal for change) | | #Code to allow a user to interactively create and update (proposal for change) |
| | #Code to apply the change file to the database. | | #Code to apply the change file to the database. |
| − | ==Using This Manual==
| |
| − | This manual is intended to be a primer on the tool, an introduction to the tool, and a reference source. The tabs at the top of the page list the various sections of this manual. This remainder of this section includes a summary of the contents for each tab, and recommended "paths" through the
| |
| − | manual for various types of readers.
| |
| − |
| |
| − | ===Summary of Tab Content===
| |
| − | [[#|'''GetStarted''' tab]]: provides this reader's guide as well as a simple overview of the application GUI.
| |
| − |
| |
| − | [[Harmonization Editor Manual (DataBase)|'''DataBase''' tab]]: Provides an overview of how the application uses the Access database in which the vocabulary specs are stored, as well as how to load, backup and restore the database from the application.
| |
| − |
| |
| − | [[Harmonization Editor Manual (Browsing)|'''Browsing''' tab]]: Provides instruction on how to use the application for browsing the HL7 Vocabulary content.
| |
| − |
| |
| − | [[Harmonization Editor Manual (Proposal)|'''Proposals''' tab]]: Provides detailed instruction on how to use the application to create '''Vocabulary Change Proposals''', how to apply these proposals to the data base and how to manage proposals. It draws upon the next three sections for even more detailed instructions/
| |
| − |
| |
| − | [[Harmonization Editor Manual (CodeSystems)|'''CodeSystems''' tab]]: Provides detailed instruction on preparing change proposals by selecting options on the Code Systems in the '''Code System Table''' of the application. As of October 2007, '''there are no such options'''.
| |
| − |
| |
| − | [[Harmonization Editor Manual (Domains)|'''Domains''' tab]]: Provides detailed instruction on preparing change proposals by selecting options on the Concept Domains listed in the '''Concept Domain Tree''' of the application. As of October 2007, '''there are no such options'''.
| |
| − |
| |
| − | [[Harmonization Editor Manual (ValueSets)|'''ValueSets''' tab]]: Provides detailed instruction on preparing change proposals by selecting options on the Value Set nodes displayed in the '''Value Set Navigator''' of the application. As of October 2007, there is a rich set of capable options for use.
| |
| − |
| |
| − | [[Harmonization Editor Manual (Tutorial)|'''Tutorial''' tab]]: Provides a step-by-step assisted walk through from starting the application through creation of a change proposal, and application of that proposal to the data base.
| |
| − |
| |
| − | [[Harmonization Editor Manual (Installation)|'''Installation''' tab]]: Provides detailed instructions on acquiring the application and installing it in Windows.
| |
| − |
| |
| − | ===Key Sections for Various Users===
| |
| − | '''<u>First Time Users</u>''' are recommended to:
| |
| − | #Review the [[#|'''GetStarted''' tab]]
| |
| − | #Install the application per the [[Harmonization Editor Manual (Installation)|'''Installation''' tab]]
| |
| − | #Perform the step-by-step exercise in the [[Harmonization Editor Manual (Tutorial)|'''Tutorial''' tab]]
| |
| − |
| |
| − | '''<u>Users Building Proposals for First Time</u>''' are recommended to:
| |
| − | #Follow the sequence for '''First Time Users''' (above)
| |
| − | #Review the section on the [[Harmonization Editor Manual (DataBase)|'''DataBase''' tab]]
| |
| − | #Get comfortable with the steps on [[Harmonization Editor Manual (Browsing)|'''Browsing''' tab]]
| |
| − | #Review the content of the [[Harmonization Editor Manual (Proposal)|'''Proposals''' tab]]
| |
| − | #Scan the contents of the [[Harmonization Editor Manual (ValueSets)|'''ValueSets''' tab]] in order to see what it contains and how it is organized
| |
| − |
| |
| − | '''<u>Users Building Harmonization Proposals</u>''' will want rapid access to the following sections for reference:
| |
| − | *[[Harmonization Editor Manual (Proposal)|'''Proposals''' tab]]
| |
| − | *[[Harmonization Editor Manual (ValueSets)|'''ValueSets''' tab]]
| |
Manual Changes for Release 1.1.0
Changes to the Editor in Release 1.1.0 changed a number of the screens and caused some of the error messages to be retired. In order to allow the manual to be used for both Release 1.0 and 1.1.0, the manual has, in most cases, been edited leaving the old content in, but "striking it out" (like this) and annotating all figures that show older, no longer valid screens.
These changes were made October 21, 2007 when the new Editor was released. The old content will be removed from the manual in a couple of weeks.
Introduction
This is the initial pass at creating a manual for the Vocabulary Harmonization Editor tool that has been developed for HL7. This application permits:
- Loading the vocabulary content from an HL7 Design Repository
- Browsing that content
- Preparing harmonization proposals for vocabulary changes
- Applying those changes to the source data base
- Amending XML proposal files with an XML editor, rather than through the application.
The foundation of this application is:
- An implementation of the HL7 CTS specification that allows it to read the HL7 vocabulary content from the design repository.
- The HL7 Vocabulary Maintenance Language that defines operations on the HL7 vocabulary data as an XML "command file". (Sections of the specification for this language are included in the documentation of this application.)
- Code to allow a user to interactively create and update (proposal for change)
- Code to apply the change file to the database.
