AIM Template Builder 2.0 User's Guide

This guide explains how to use Annotation and Image Markup (AIM) to build templates that are compatible with the AIM information model. The intended audience for this guide is a biomedical researcher familiar with the AIM information model.

Getting Started with AIM Template Builder

Return to top of page

Why Use the AIM Model?

Imaging reports contain both graphical drawings and medical knowledge in the form of annotations. These annotations are stored as unstructured text and separated from graphical drawings, which are typically in a proprietary format on an imaging system. Extracting this valuable medical information and combining it with drawings on another system is a time-consuming process that yields results that are cumbersome to filter and search. Also, existing vocabularies used to describe medical images contain thousands of terms. This makes it difficult for users to find these terms and then include them in their AIM annotations.

The AIM model begins to solve this problem by capturing the descriptive information of an image with user-generated graphical symbols placed on the image into a single common information source. AIM captures medical findings using standard vocabularies such as RadLex, SNOMED CT_^®, and DICOM, and user-defined terminology. Image information captured in the AIM model includes the anatomic entity and its characteristics, imaging observation and its characteristics, and inference.

Return to top of page

What is in an AIM Template?

Return to top of page

Configuring ATB for Publishing

You must configure ATB so that it can find the AIM Template Service and include the appropriate user name in an AIM template. The AIM Template Service is web service that can be used to store, search, and retrieve AIM template XML documents.

1. Click the Settings button ().
   The Options window appears.
   
2. Change the caGrid Userame value to the name you used when you  registered for your caGrid account. You must have a caGrid account to publish templates to the ATS. 
3. Change the ATS URL value to the server where the AIM Template Service you will use is located. If you are not hosting your own AIM Template Service instance, the URL is http://imaging.fsm.northwestern.edu.
4. Confirm or change the Default Author. The default author's name appears in the metadata of any object you create in ATB.
5. Click Save.

Return to top of page

Working with Template Groups

A template group is a container that holds individual templates.

Adding a Template Group

1. Click the Template Groups tab.
2. Below the left panel, click .
   The Group Members panel at the bottom of the application expands to include a new template group panel.
   
3. Enter the name of the new group, its version number and description, and your name in the boxes provided. You can edit this information later if needed.
4. Click Save.
   The new template group appears in the Groups panel on the left side of the application.

Return to top of page

Deleting a Template Group

Deleting a template group does not delete the templates within it.

1. Click the Template Groups tab.
2. Select the template group you want to delete by clicking it.
3. Below the left panel, click .
   A message appears asking you to confirm the deletion.
4. Click Delete.

Return to top of page

Editing a Template Group

You can edit the name, version, description, and author of a template group.

1. Click the Template Groups tab.
2. Below the left panel, click .
   The selected template group's description appears.
3. Change the name of the group, version, description, and authors as needed.
4. Optionally, add a tag to the group to make it easier to search for the template group in the future.
5. Click Save.
   The edited template group appears in the Groups panel.

Return to top of page

Copying a Template Group

You can create a copy of a template group to make it easier for you to customize it.

1. Click the Template Groups tab.
2. Select the template group you want to copy.
3. At the bottom of the Groups panel, click .
   A copy of the template with the name of Current Template Name copy appears in the Groups panel. You can now customize the copied template group.

Return to top of page

Searching for a Template Group

When you search the AIM Template Service for a template group that you want to modify in ATB, you import it at the same time. You do not have to take a separate step to download the template group. Once you find the template group in the search results, click it to begin using it in ATB.

1. Click the Template Groups tab.
2. Below the left panel, click and then select Search Groups.
   The Template Groups Search page appears.
   

3. Narrow your search by entering information into the fields. If you do not enter any information into the fields, all template groups available in ATS appear, and it may take longer to see the results of your search. The following fields are available.

   Field	Description
   Container Name	Template group name
   Container Description	Template group description
   Container Author	Person who created the template group in the AIM-enabled application
   Disease	Disease that is the topic of the templates in the template group
   Body Part	Body part that is the topic of the templates in the template group
   Tag Name	A name associated with this template group
   Tag Value	The value associated with the tag name for this template group

4. Click Search.
   All template groups matching the search criteria you entered appear.
   
5. Click the name link for a template group.
   ATB imports the template.

Return to top of page

Importing a Template Group

Return to top of page

Exporting a Template Group

You can export a template group you created in AIM Template Builder to use it in an AIM-enabled workstation. Template groups created in AIM Template Builder validate the AIM template schema,  AIMTemplate_v2rv13.xsd, and are in XML format.

1. Click the Template Groups tab.
2. Select the template group you want to export.
3. Below the left panel, click .
4. Click Export.
   The Save dialog box appears.
5. Select a location where you want to save the template group XML file.

Return to top of page

Publishing a Template Group

You can publish a template group that you created in AIM Template Builder to the AIM Template Service so that others can find it or so that you can import it into another application.

1. Click the Template Groups tab.
2. Select a template group from the Groups panel.
3. Below the left panel, click .
4. Click Publish.
   A window opens, prompting you to log in to the AIM Template Service.
5. Enter your password or log in as a different user and then click Login. You must have a caGrid account to publish templates to the ATS.
   The steps that follow are unique to your configuration of the AIM Template Service.

Return to top of page

Adding a Tag to a Template Group

Associating one or more tags with a template group makes it easier for you to find and others to discover a template group that you created. Tags are composed of a name and a value. The tag name must be a lexicon term. The tag value can be a string you enter or a lexicon term.

1. Click the Template Groups tab.
2. Select a template group.
3. Below the left panel, click .
   The selected template group's description appears.
4. Click .
5. Double-click the Name column.
   The Edit Tag Name dialog box appears.
   

   

6. Click Select Term.
   The Lexicon Search dialog box appears.
7. Select a lexicon name and then search for an existing term. For example, in the following window, the selected lexicon is SNOMED_CT and the term is Disease.
   

   

8. Click Save.
9. Assign a code or string value to the term by clicking the Value column, entering the code or string value (for example, GBM), and then clicking Enter.
10. Click Done.
    You can see the tag when you open the template group.
    

    

Return to top of page

Deleting a Tag from a Template Group

1. Click .
2. Select the tag you want to delete.
3. Click .

Return to top of page

Working with Templates

When you design a template, it is helpful to keep the purpose in mind. A template structures how users will enter information into an imaging application. The following table may help make the connection between the AIM Template Builder and information entered into an imaging application.

Return to top of page

Creating a Template

1. Click the Templates tab.
2. Below the left panel, click .
   The new template window appears.
   
3. Enter a name, description, and version for the template. The UID is also a required field but the AIM Template Builder supplies it automatically. Optionally, select values for Modality and Preceding Annotation.
4. Click Save.
   The new template appears in the Templates panel. You may see warnings depicted by red circles with white x's in the template. For example, if you have not yet assigned the required metadata, you are notified that it is missing. The Description section below the Template Components panel shows the list of warnings. Click the warning to move to the problem location and fix it.
   
5. Add a tag (also called a code) to the template. Tags can either be string values or lexicon terms. A template must have a code assigned to it. The assigned code describes the purpose of the template.
6. Add one or more components to the template. Components can be anatomic entity, imaging observation, inference, calculation, and markup or geometric shape.
7. Add one or more characteristics to each template component you add, as applicable (Inference and Calculation components do not have associated characteristics).

8. Specify the answer choices for each characteristic (for Anatomic Entity and Image Observation components) or component (for Inference and Calculation components).

   Expanding and collapsing

   You can expand or collapse template components by double-clicking them or by clicking the plus or minus buttons in the upper right of the Template Components panel. When you expand a template component, you see all of its characteristics. When you collapse it, you see only the template component name.

Return to top of page

Adding a Template Component

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add a component.

3. In the Template Components panel, right-click the template name. A window appears that shows the template components you can create.
   
   You can also access these options in the toolbar below the Template Components panel.
   

4. Create a anatomic entity, imaging observation, inference, calculation, geometric shape, or tag.
   
   

Return to top of page

Creating an Anatomic Entity

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add an anatomic entity.
3. In the Template Components panel, right-click the template name and select Create Anatomic Entity. You can also find this option in the toolbar ().
   A new panel appears on the right and the toolbar below the Template Components panel changes to provide options for anatomic entities.
4. In the panel on the right, provide the required information, as follows:
   
   1. Provide a Label for the anatomic entity. For example, "Where is the tumor located?"
   2. Provide Explanatory Text to better describe the label.
   3. Specify the minimum and maximum number of Answer Choices that the person answering the related question may select in the template.
   4. Select the button that describes your display preference for the anatomic entity in the template.
   5. Select the button that describes your display preference for Annotator Confidence.
   6. Specify whether or not a comment is required.
   7. Specify one or more names in the Default Authors field to show who created the entity. 
   8. Optionally, provide a Group Label, which can show an affiliation between this entity and others in the same group.
5. Click Save.
6. Add one or more characteristics to the anatomic entity.
   For example, to describe a screen that is ruptured, the AIM template captures an anatomic entity of spleen and an anatomic entity characteristic of ruptured.

Return to top of page

Creating an Imaging Observation

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add an imaging observation.
3. In the Template Components panel, right-click the template name and select Create Imaging Observation. You can also find this option in the toolbar ().
   A new panel appears on the right and the toolbar below the Template Components panel changes to provide options for imaging observations.
4. In the panel on the right, provide the required information, as follows:
   
   1. Provide a Label for the imaging observation. For example, "Where is the mass located?"
   2. Provide Explanatory Text to better describe the label.
   3. Specify the minimum and maximum number of Answer Choices that the person answering the related question may select in the template.
   4. Select the button that describes your display preference for the imaging observation in the template.
   5. Select the button that describes your display preference for Annotator Confidence.
   6. Specify whether or not a comment is required.
   7. Specify one or more names in the Default Authors field to show who created the imaging observation. 
   8. Optionally, provide a Group Label, which can show an affiliation between this imaging observation and others in the same group.
5. Click Save.
6. Add one or more characteristics to the imaging observation.
   For example, to describe an image showing a cystic mass, the AIM template captures an imaging observation of mass and an imaging observation characteristic of cystic.

Return to top of page

Creating an Inference

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add an inference.
3. In the Template Components panel, right-click the template name and select Create Inference. You can also find this option in the toolbar ().
   A new panel appears on the right and the toolbar below the Template Components panel changes to provide options for inferences.
4. In the panel on the right, provide the required information, as follows:
   
   1. Provide a Label for the inference.
   2. Provide Explanatory Text to better describe the label.
   3. Specify the minimum and maximum number of Answer Choices that the person answering the related question may select in the template.
   4. Select the button that describes your display preference for the inference in the template.
   5. Select the button that describes your display preference for Annotator Confidence.
   6. Specify whether or not a comment is required.
   7. Specify one or more names in the Default Authors field to show who created the inference. 
   8. Optionally, provide a Group Label, which can show an affiliation between this inference and others in the same group.
5. Click Save.
6. Add one or more questions to the inference.

Return to top of page

Creating a Calculation

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add a calculation.
3. In the Template Components panel, right-click the template name and select Create Calculation. You can also find this option in the toolbar ().
   The toolbar below the Template Components panel changes to provide options for calculations.
4. In the panel on the right, provide the required information, as follows:
   
   1. Provide a Label for the calculation.
   2. Provide Explanatory Text to better describe the label.
   3. Specify the minimum and maximum number of Answer Choices that the person answering the related question may select in the template.
   4. Select the button that describes your display preference for the inference in the template.
   5. Select the button that describes your display preference for Annotator Confidence.
   6. Specify whether or not a comment is required.
   7. Specify one or more names in the Default Authors field to show who created the calculation. 
   8. Optionally, provide a Group Label, which can show an affiliation between this calculation and others in the same group.
   9. If this is the last question in the template, select No More Questions.
   10. If this is not the last question, select the question that should follow this one from the options in the Next Question to Ask box.
5. Click Save.
6. Right-click the calculation and select Create Calculation Type. You can also find this option in the toolbar ().
   The toolbar below the Template Components panel changes to provide options for calculation types, which are to Add Valid Terms, Create Algorithm Type, and Delete Calculation Type ().

Return to top of page

Creating an Algorithm Type

Algorithms are types of calculations that you can add to an AIM template.

1. Create a Calculation.
2. Click to add an algorithm type to the calculation type.
   A new panel appears on the right for algorithm attributes.
   

3. Provide attributes for the algorithm type.

   Field	Description
   Description	Explanatory text about the component
   Unique Identifier	Any string that uniquely identifies this algorithm
   Algorithm Name	Algorithm name
   Algorithm Version	Algorithm version
   MathML	An optional mathML representation of the calculation

4. Click Save.

Return to top of page

Creating a Geometric Shape

Geometric shapes, which are equivalent to markups, describe a user's region of interest on an image and are patterned after DICOM SR graphical types. Combinations of these shapes can be used to represent graphical drawings placed on images.

1. Click the Templates tab.
2. In the Templates panel, select the template to which you want to add a geometric shape.
3. In the Template Components panel, right-click the template name and select Create Geometric Shape. You can also find this option in the toolbar ().
   A new panel appears on the right and the toolbar below the Template Components panel changes to provide the option for geometric shapes.
4. In the panel on the right, provide the required information, as follows:
   
   1. Provide a Label for the calculation.
   2. Provide Explanatory Text to better describe the label.
   3. Specify the minimum and maximum number of Answer Choices that the person answering the related question may select in the template. Answer Choices inform the AIM template user how many markups the user has to create. For example, if there are two circles (min=max=2), the user should create two circles. If a multipoint is assigned with a value min=max=2, ATB interprets that this is a line (with two points, x1,y1 and x2,y2). Developers of an AIM-enabled workstation must know how to map AIM template markup to an appropriate graphical drawing tool on their workstation.
   4. Select the button that describes your display preference for the inference in the template.
   5. Select the button that describes your display preference for Annotator Confidence.
   6. Specify whether or not a comment is required.
   7. Specify one or more names in the Default Authors field to show who created the calculation. 
   8. Optionally, provide a Group Label, which can show an affiliation between this calculation and others in the same group.

   9. Select the Shape Type from the options of two-dimensional and three-dimensional shapes.
      The geometric shapes available are as follows. ATB follows the DICOM standard.

      Shape	Description
      2D Point (Arrow)	A single pixel denoted by a single (column,row) pair
      2D Circle	A circle defined by two (column,row) pairs. The first point is the central pixel. The second point is a pixel on the perimeter of the circle.
      2D Polyline (Closed Polygon)	A series of connected line segments with ordered vertices denoted by (column,row) pairs. If the first and last vertices are the same, it is a closed polygon.
      2D Ellipse	An ellipse defined by four pixel (column,row) pairs. The first two points specify the endpoints of the major axis and the second two points specify the endpoints of the minor axis of an ellipse.
      2D Multipoint (Connected Points)	Multiple pixels each denoted by a (column,row) pair
      3D Polygon (Closed Coplanar Polygon)	A series of connected line segments with ordered vertices denoted by (x,y,z) triplets, where the first and last vertices shall be the same forming a polygon; the points shall be coplanar.
      3D Polyline (Connected Line Segments)	A series of connected line segments with ordered vertices denoted by (x,y,z) triplets. The points need not be coplanar.
      3D Multipoint (Series of Points)	Multiple locations each denoted by an (x,y,z) triplet. The points need not be coplanar.
      3D Point (Arrow)	A single location denoted by a single (x,y,z) triplet.
      3D Ellipse	An ellipse defined by four (x,y,z) triplets. The first two triplets specify the endpoints of the major axis and the second two triplets specify the endpoints of the minor axis.
      3D Ellipsoid	A three-dimensional geometric surface whose plane sections are either ellipses or circles and contains three intersecting orthogonal axes, “a”, “b”, and “c”. The ellipsoid is defined by six (x,y,z) triplets, the first and second triplets specifying the endpoints of axis “a”, the third and fourth triplets specifying the endpoints of axis “b”, and the fifth and sixth triplets specifying the endpoints of axis “c”.

   10. If this is the last question in the template, select No More Questions.

   11. If this is not the last question, select the question that should follow this one from the options in the Next Question to Ask box.

5. Click Save.

Return to top of page

Adding Tags to a Template

Associating one or more tags with a template makes it easier for you to find and others to discover a template that you created. Tags are composed of a name and a value. The tag name must be a lexicon term. The tag value can be a string you enter or a lexicon term.

1. Click the Templates tab.
2. Select a template.
   The template components appear in the center panel.
3. In the Template Components panel, right-click the template name.
4. From the menu that appears, select .
   A new tag appears in the Template Components panel.
   
5. Provide the tag name and value.
   
   • To provide the tag name, click Select Term in the Lexicon Term (Tag Name) panel in the top right. A tag must contain at least three characters.
   • To provide the tag value, enter your own or select a term from the lexicon. To enter your own value, click Use String Value and then enter a value in the String Value box.
6. Click Save.

Return to top of page

Managing Question and Answer Choices

Adding Answer Choices

Return to top of page

Modifying Answer Choices

You can modify an answer choice by choosing a different lexicon term for it, changing its metadata, making it the default answer, or making its selection indicate that the template user has reached the last question.

1. Select an answer choice belonging to a template component.
   The metadata associated with that answer choice appears in the right panel.
2. Below that metadata, click Select Term.
   The Lexicon Search dialog box appears. The term you selected appears in the Lexicon Term panel on the right.
3. From the list on the far left of the page, select at least one lexicon where you believe the term you are searching for is located. Click and hold the Shift or Ctrl key to select multiple lexicons.
4. In the list to the right, enter the term you want to search for. Options include the following:
   
   • Click Whole word if you are entering the whole word and want to restrict your search to it.
   • Enter only part of the term, such as "Tum" for "Tumor".
   • Do not enter any terms to retrieve all terms in the selected lexicon(s).
5. Click . All lexicon entries matching your search criteria appear in the search results.
6. Select a term in the search results.
   The selected term replaces your original term in the Lexicon Term panel.
7. Click OK.
   The Templates tab appears with the lexicon term in the right panel.
   

8. Click the Default Answer checkbox if you want this answer choice to be the default answer. If you choose this, the answer choice is preceded by a blue icon in the Template Components tree, as follows:

   The number of default answers must be equal or greater than the minimum number of answer choices you specified when you added this characteristic to the template component.

9. Select the No More Questions checkbox if you want the selection of this answer choice to indicate that this is the last question in the template.
10. In the Next Question to Ask section, highlight the next question that the template should ask the user. This selection is not available if you have identified this as the last question in the template.
11. Click Save.

Return to top of page

Adding Valid Terms to an Answer Choice

When an answer choice must be specific, you can add valid terms to the answer choice so that the template forces the user to specify one of those terms.

1. In the Template Components panel, right-click an answer choice and select Add Valid Terms or select  in the toolbar.
   The Lexicon Search page appears.
2. Select a valid term from a lexicon you have created as follows.
   
   1. From the list on the far left of the page, select at least one lexicon where you believe the term you are searching for is located. Click and hold the Shift or Ctrl key to select multiple lexicons.
   2. In the list to the right, enter the term you want to search for. Options include the following:
      Click Whole word if you are entering the whole word and want to restrict your search to it.
      Enter only part of the term, such as "Tum" for "Tumor".
      Do not enter any terms to retrieve all terms in the selected lexicon(s).
   3. Click . All lexicon entries matching your search criteria appear in the search results.
   4. Select a term in the search results.

   5. Click .
      The valid term appears in the Answer Choices list in the right panel, as shown below. Relevant steps in the selection of this valid term are highlighted in red.
      

      Slide panel borders

      Adjust your view of the information in multiple panels by clicking and dragging the border between them.

   6. Click Save.
      The valid term appears in the Template Components panel under the answer choice you originally selected.

3. Repeat this procedure until you have added all of the valid terms for the answer choice. You can also add valid terms to other valid terms.

Return to top of page

Adding a Characteristic to a Template Component

Return to top of page

Creating a Question

AIM templates include a set of questions and one or more answer choices for each question.

1. Add a template component.
2. Right-click the template component and select Create Question. You can also find this option in the toolbar ().
   A new panel appears on the right and the toolbar below the Template Components panel changes to provide options for question, which are to add or delete a question ().
   

3. Provide information about the question.

   Field	Description
   Code Meaning	The lexicon term you want to use in the question
   Code Value	The value of the lexicon term
   Schema Designator	The organization that created the schema
   Schema Version	The version of the schema you are using

   In this version of ATB, a question is defined as a concept code. This means that you will have to select a concept code from a list of existing lexicons from your local ATB. If you don’t have a concept code defined, which you probably don’t have in your local ATB, you will have to create your private lexicon that consists of your set of questions.
   
   Refer to the Questions and instructions lexicon for example questions to consider.

   Example

   You may want to create the following question: Where is a tumor located?
   
   You may define the question as follows.

   1. Create a lexicon called My private questions.
      
      1. Select the Lexicon tab.
      2. Click to add a new lexicon.
      3. Enter the metadata as follows:
         Name: My Private Lexicon
         Schema Designator: MPL
         Schema Version: 1.0
         Description: My private lexicon
         Authors: NCI
      4. Click Save.
   2. Click to add a new term.
   3. Enter the metadata as follows:
      Code Meaning: Where is the tumor?
      Description: Identify where the tumor is on the image or images.
      Code Value: MPL-0001
   4. Click Save. You can now use this question concept code.
4. Click Save.
5. Add answer choices to the question. Answer choices are lexicon entries that you want to reference in a question in the template.

Return to top of page

Skipping Questions in a Template

When you create a template, you add questions and answer choices that are usually presented sequentially. However, you may want certain answer choices to trigger a different question than the next one in the template. You can specify the next question to ask for each answer choice.

1. Select the Templates tab.
2. Select an answer choice belonging to a template component.
   
3. In the Next Question to Ask section on the right, select the next question to ask from the list of template questions. This does not need to be a sequential question. Note that in the example above, the answer choice belongs to the Tumor Location component and Side of Tumor Center characteristic. The next question in the template is Lesion ("Select the type of lesion") but the selected next question to ask is Eloquent Brain ("Select Eloquent Brain involvement feature").
4. Click Save.

Return to top of page

Creating a Characteristic Quantification

1. Add a template component of the Imaging Observation or Anatomic Entity type.
2. Add a characteristic to a template component of the Imaging Observation or Anatomic Entity type.
3. Add an answer choice to the characteristic.
4. Right-click the answer choice and select Create Characteristic Quantification ().
5. In the panel on the right, enter a name for the characteristic and select Annotator Confidence, if that attribute applies to the template component.
6. Click Save.

7. Create a characteristic quantification type. The options include Non Quantifiable, Scale, Numerical, Quantile, and Interval. Except for the Non Quantifiable type, which can always be added, you cannot create more than one type for a single answer choice.

   Note

   Delete any quantification from an answer choice by right-clicking it and selecting .

Return to top of page

Creating a Non Quantifiable

1. Add a characteristic to the component.
2. Add an answer choice.
3. Right-click the answer choice and select Create Non Quantifiable ().
4. Search for the lexicon term you want to use to describe the non quantifiable.
   
   1. Click Select Term.
      The Lexicon Search dialog box appears.
   2. From the list in the center of the page, select at least one lexicon where you believe the term you are searching for is located.
   3. From the list that is furthest to the left on the page, enter the term you want to search for. You can also enter only part of the term, such as "Non" for "None", and then select RadLex from the lexicon list.
   4. Click .
      All lexicon entries containing the word you entered appear in the search results.
   5. Select a term in the search results.
   6. Click OK.
      The metadata for the lexicon term you selected populates the Code Meaning, Code Value, Schema Designator, and Schema Version fields.
5. Click Save.

Return to top of page

Creating a Scale

1. Add a characteristic to the component.
2. Add an answer choice.
3. Right-click the answer choice and select Create Scale ().
4. Add a description of the scale and additional comment, if needed.
5. Click Save.
6. Right-click the scale and select Create Ordinal Level ().
7. Provide a value for the ordinal level by typing in a number or using the arrow keys to reach the desired number.
8. Optionally, describe the ordinal level.
9. Click Save.
10. Return to step 3 to create additional ordinal levels.

Return to top of page

Creating a Numerical

1. Add a characteristic to the component.
2. Add an answer choice.
3. Right-click the answer choice and select Create Numerical ().
4. Provide a value and UCUM string for the numerical (required).
5. Select an operator from the list (optional).
6. Click Save.

Return to top of page

Creating a Quantile

1. Add a characteristic to the component.
2. Add an answer choice.
3. Right-click the answer choice and select Create Quantile ().
4. Enter a value into the Bins field.
   For example, if your range is 100, you could create 5 bins containing 20 units each. Your Bin number would be 5 in this case.
5. Click Save.

Return to top of page

Creating an Interval

1. Add a characteristic to the component.
2. Add an answer choice.
3. Right-click the answer choice and select Create Interval ().
4. Specify Min Value, Max Value, Min Operator, Max Operator, and UCUM Value for an interval.
5. Click Save.
6. Return to step 3 to create additional intervals.

Return to top of page

Searching for a Template in the AIM Template Service

Return to top of page

Importing a Template from the AIM Template Service

Once you find a template after searching the ATS, you can simply click it to import it to ATB.

1. Search for a template in ATS.

2. Click the Name link of the template you want to import.
   The template you imported appears in the Templates panel as "Copy of Original Template Name".

Return to top of page

Editing a Template

1. Click the Templates tab.
2. Select the template you want to edit. The template information appears in the right panel.
3. Edit any of the information about the template that you want to change.
4. Click Save.

Return to top of page

Copying a Template

You can create a copy of a template to make it easier for you to customize it.

1. Click the Template tab.
2. Select the template you want to copy.
3. At the bottom of the Templates panel, click .
   A copy of the template with the name of Current Template Name copy appears in the Templates panel. You can now customize the copied template.

Return to top of page

Deleting a Template

1. Click the Templates tab.
2. Select the template you want to delete by clicking it.
3. Below the left panel, click .
   A message appears prompting you to confirm the deletion.
4. Click Delete.
   The template is no longer in the Templates panel.

Return to top of page

Adding a Template to a Template Group

Return to top of page

Removing a Template from a Template Group

1. If you are not already on the Template Groups tab, click it to select it.
2. In the Group Memberships panel on the right side of the screen, click the box next to the template you want to remove from the template group.
3. Click .
   The page refreshes and the Group Members panel no longer shows the template in the template group.

Return to top of page

Building a Lexicon

Return to top of page

Creating a Lexicon

1. Click the Lexicons tab.
2. In the toolbar at the bottom of the page, select .
   A panel for information about the new lexicon appears.
   
3. Enter information about the lexicon. Lexicon name and Schema Designator are required and the rest of the fields are optional. You can change the Authors from what appears by default, which is the user who is currently logged in. If the Is Read-Only checkbox is selected, this is a lexicon built in to ATB 2.0 and you cannot modify it.
4. Click Save. The lexicon appears in the Lexicon panel.
   
   

Return to top of page

Creating a Lexicon File Outside of ATB 2.0

Return to top of page

Deleting a Lexicon

1. Click the Lexicons tab.
2. Select the lexicon you want to delete by clicking it.
3. At the bottom of the Lexicon panel, click .
   A confirmation message appears.
4. Click Delete. The lexicon is no longer in the Lexicon panel.

Return to top of page

Creating a Lexicon Entry

1. Click the Lexicons tab.
2. Select the lexicon that you want to contain your new lexicon entry.
3. Right-click the lexicon and select Create Lexicon Entry, or click in the toolbar.
   A panel for the new lexicon entry appears.
   

4. Complete the fields to describe the lexicon entry.
   An explanation of the purpose of each field is shown in the table below.

   Field	Description
   Code Meaning	The name of the term you want to use as the lexicon entry
   Description	A description of the term
   Code Value	The value assigned by the coding scheme designator

5. Click Save.

Return to top of page

Deleting a Lexicon Entry

1. Click the Lexicons tab.
2. Select the lexicon that contains the term you want to delete.
3. Click the term you want to delete to select it.
4. Click .
   A confirmation message appears.
5. Click Delete. The lexicon entry no longer appears in the Lexicon Terms panel.

Return to top of page

Searching for a Term

1. Click the Lexicons tab.
2. At the bottom of the Lexicons panel, click the Search Terminology button ().
   The Lexicon Search window appears.
   
3. From the list on the far left of the page, select at least one lexicon where you believe the term you are searching for is located. Click and hold the Shift or Ctrl key to select multiple lexicons.
4. In the list to the right, enter the term you want to search for. Options include the following:
   
   • Click Whole word if you are entering the whole word and want to restrict your search to it.
   • Enter only part of the term, such as "Tum" for "Tumor".
   • Do not enter any terms to retrieve all terms in the selected lexicon(s).
5. Click .
6. All lexicon entries matching your search criteria options appear in the search results.
7. Click to select a term from the search results.
8. Click Save.
   The term appears in the Lexicon Terms panel of the Lexicons tab.

Return to top of page