Difference between revisions of "Built-in Code Sets"

From SmartWiki
Jump to: navigation, search
 
(25 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
=Overview=
 
=Overview=
−
The [[SmartSimple]] platform comes with built-in code sets to help streamline the user's ease of look-up, identification, and categorization of various items specific to their [[instance]]. The three main built-in code sets include '''MeSH, NAICS''' and '''ICD'''.
+
The [[SmartSimple]] platform comes with built-in code sets to help streamline the user's ability to categorize various items specific to the purpose of their [[instance]], dependent on the vertical market they belong to or the usage or their platform. The three main built-in code sets include '''MeSH, NAICS''' and '''ICD'''.
−
 
 
−
Each code set corresponds to the categorization of a specific ''type'' of item that is beneficial to differing clients depending on which vertical market they belong to.
 
  
 
To enable these code sets as [[Custom Field]] options, you will need [[Global User Administrator]] access. 
 
To enable these code sets as [[Custom Field]] options, you will need [[Global User Administrator]] access. 
Line 24: Line 22:
  
 
||
 
||
−
'''MeSH''' includes the list of medical terms used by the National Library of Medicine (NLM) for its computerized system of storage and retrieval of published medical reports.
+
'''MeSH''' includes the list of medical terms used by the [https://www.nlm.nih.gov/mesh/meshhome.html National Library of Medicine] (NLM) for its computerized system of storage and retrieval of published medical reports.
  
 
As a comprehensive controlled vocabulary, '''MeSH''' serves as a thesaurus that facilitates searching within the medical research market.
 
As a comprehensive controlled vocabulary, '''MeSH''' serves as a thesaurus that facilitates searching within the medical research market.
Line 32: Line 30:
 
* the classification of specific details within medical research 
 
* the classification of specific details within medical research 
  
−
''Ex: ''
+
''Ex: Neuroimagery, animals, depression''
  
 
|-
 
|-
Line 41: Line 39:
  
 
||
 
||
−
The '''ICD''' code set, currently on its 10th revision, is a medical classification list by the World Health Organization (WHO).
+
The '''ICD''' code set, currently on its 10th revision, is a [https://www.cdc.gov/nchs/icd/icd10cm.htm medical classification list] by the World Health Organization (WHO).
  
 
It contains codes for diseases, signs and symptoms, abnormal findings, complaints, social circumstances and external causes of injury and diseases.
 
It contains codes for diseases, signs and symptoms, abnormal findings, complaints, social circumstances and external causes of injury and diseases.
Line 58: Line 56:
  
 
||
 
||
−
'''NAICS''' is an industry classification system developed by the statistical agencies of Canada, Mexico, and the United States, created against the background of the North American Free Trade Agreement (NAFTA).
+
[https://www.statcan.gc.ca/eng/subjects/standard/naics/2017/v3/index NAICS] was developed as the standard for use by US, Canadian and Mexican agencies in classifying business establishments for the collection, analysis, and publication of statistical data related to the business economy.
−
 
 
−
'''NAICS''' is designed to provide common definitions of the industrial structure of the three countries - it encompasses all economic activities, and is designed for the classification of data relating to industry establishments.
 
  
 
||Industry
 
||Industry
Line 86: Line 82:
 
||[[Custom Field Type: Lookup – NAIC Codes]]
 
||[[Custom Field Type: Lookup – NAIC Codes]]
 
|}
 
|}
 +
Each field has a ''lookup ''function that facilitates the ease of finding the desired codes.When setting the field, the user is able to search for specific codes either by writing a description of the categorization, or by the numerical code. A list of matching items will appear and the user can choose the appropriate option from the list. 
 +
 +
[[Image:Cf_icd_ex1.png|thumb|none|570px|Lookup - ICD Code field, in Edit Mode]]
 +
 +
[[Image:Cf_icd_ex2.png|thumb|none|400px|Lookup - ICD Code field, in View Mode]]
 +
 
==Enabling as Custom Field==
 
==Enabling as Custom Field==
 
These built-in code sets must first be enabled in order to utilize them as look up options in your system.
 
These built-in code sets must first be enabled in order to utilize them as look up options in your system.
  
 
<pre> You will need SysAdmin access to enable any of these code sets as Custom Fields. </pre>
 
<pre> You will need SysAdmin access to enable any of these code sets as Custom Fields. </pre>
−
===Enabling NAIC Codes===
 
 
1. Click on the 9-square menu icon on the top right of your page.
 
1. Click on the 9-square menu icon on the top right of your page.
  
Line 98: Line 99:
 
3. Click on the '''Organizations '''tab.
 
3. Click on the '''Organizations '''tab.
  
−
4. 
+
4. Under '''General Settings, '''select '''Custom Fields.'''
 +
 
 +
:: [[File:082719_customfields.png|thumb|none|500px]]
 +
5. Click on the '''+ '''icon in the top right to create a new custom field.
 +
 
 +
:: [[File:New field button.png|thumb|none|80px|border]]
 +
The '''New Custom Field '''page will be displayed.
 +
 
 +
6. Click into the '''Field Type '''box and scroll down until the heading '''Special Input Types.'''
 +
 
 +
:: [[File:082719 special codesets types.png|thumb|none|400px|border]] 
 +
The three built-in code sets will be available to choose.
 +
 
 +
7. Select which '''Custom Field Type '''you want, fill in the remainder of the fields, and click the '''Save''' button.
 +
 
 +
For more information about filling out the fields for a new custom field, see our [[Custom Fields – General Information#Common Custom Field Functions|Custom Fields General Settings]] article.
 +
 
 +
<pre> These built-in code sets can also be enabled as custom fields through the same process on specific UTAs. </pre>
 +
==Choosing the Region of NAIC Codes==
 +
The '''NAIC '''codes will show up as a '''[[Standard Organizational Field]] '''for a company. When you enable '''NAIC '''codes as a field, you have the option to choose the region of the code: 
 +
 
 +
:: [[File:Naic region options.png|500px|border]]
 +
{| class="wikitable"
 +
|-
 +
||'''NAIC Region'''
 +
||'''Description'''
 +
|-
 +
||US NAIC
 +
||Enabling this region will allow users to select the NAIC codes related to businesses in the United States. 
 +
|-
 +
||Canada NAIC, English
 +
||Enabling this region will allow users to select the NAIC codes in English related to Canadian businesses.
 +
|-
 +
||Canada NAIC, French
 +
||Enabling this region will allow users to select the NAIC codes in French related to Canadian businesses. 
 +
|-
 +
||European NACE
 +
||
 +
NACE is the acronym used to designate the various statistical classifications of economic activities developed since 1970 in the European Union.
 +
 
 +
Enabling this region will allow users to select the NACE codes related to European businesses. 
 +
 
 +
|}
 +
Choose the region that the [[Organization|organizations]] of your [[instance]] will require. 
 +
 
 +
=Configuration - Advanced=
 +
==Using the Custom Field Import Wizard==
 +
You are able to use the custom field '''Import '''and '''Export '''features to move or copy custom fields from one [[entity]] to another (or even another [[instance]] of SmartSimple). The custom fields are exported and imported by using [[XML]] (Extensible Markup Language) format.
 +
 
 +
As the [[Custom field ID|custom field ID]] is unique to each custom field in the system, the custom field IDs will not be copied when importing. Any newly created custom fields using the Export/Import feature will be assigned new custom field IDs. 
 +
 
 +
Use the following IDs for the built-in code sets when trying to create a custom field for that type: 
 +
 
 +
{| class="wikitable"
 +
|-
 +
||'''Custom Field Type Name'''
 +
||'''Custom Field Type ID'''
 +
|-
 +
||Lookup - MeSH Codes
 +
||81
 +
|-
 +
||Lookup - ICD Codes
 +
||74
 +
|-
 +
||Lookup - NAIC Codes
 +
||77
 +
|}
 +
For more specific information and instructions about importing or exporting the custom fields of these built-in code sets, see [[Custom Fields – General Information#Import and Export Custom Fields|our custom field import/export]] article and the [[Custom Field Import Wizard]] article. 
 +
 
 +
==Enabling KML on ICD and NAIC Custom Field==
 +
'''KML '''(Keyhole Markup Language) is a file format used to display geographic data in Earth browsers such as Google Earth, Google Maps, and Google Maps for mobile. Using a tag-based structure with nested elements sand attributes, and based on [[XML]] standard, '''KML '''allows the visual mapping of field information in your platform. 
 +
 
 +
Currently, KML can be enabled on both the '''Lookup - NAIC Codes '''and the '''Lookup - ICD Code '''custom fields. 
 +
 
 +
In order to do so, follow these steps: 
 +
 
 +
1. Click on the 9-square menu icon on the top right of your page.
 +
 
 +
:: {{Icon-Menu}} 
 +
2. Click '''[[Global Settings]]. '''
 +
 
 +
3. Select '''Custom Fields '''under the first '''System '''tab. 
 +
 
 +
4. Edit the custom field (either '''NAIC '''or '''ICD''') that you want to enable KML on. 
 +
 
 +
5. Under '''General Options, '''select the '''Enable KML '''option.
 +
 
 +
:: [[File:EnableKML.png|120px|border]] 
 +
6. Click '''Save.'''
 +
 
 +
Fields that contain '''SmartSimple KML Variables '''will display as a '''View Map '''button in [[View Mode]]: 
 +
 
 +
{| class="wikitable"
 +
|-
 +
! align="center"|[[Image:KMLFieldEditMode.png|link=|300px]]
 +
!|[[Image:KMLFieldViewMode.png|link=|300px]]
 +
|-
 +
!|Field in Edit Mode
 +
!|'''Field in View Mode'''
 +
|}
  
−
The article should probably also reference the use of System Variables as the source of custom codes, with the limitation that these can only be presented though standard custom field types.
+
For more information about KML, as well as various methods of enabling KML into your SmartSimple [[instance]], please see the [[KML]] Wiki article.
  
−
<pre><em>Must enable NAIC Codes </em>thru the <em>Global Settings </em>page. </pre>
+
==Display Code Description with System Variables==
−
- you are able to set two codes for each organisation --> a primary and a secondary code 
+
For these built-in code sets, the field stores the actual ICD, MeSH, or NAIC code (i.e. ''G44.0''). In order to display the ''description ''associated with a specific code (such as ''Cluster Head Syndrome ''for the ICD code), you can use the following syntax in a [[Read Only - System Variables]] custom field, [[Web Page View]], or wherever else the use of system variables is appropriate: 
  
 +
<pre> @fieldname.value@</pre>
 +
Where ''fieldname ''is the '''name '''of the '''Lookup - ICD Code '''custom field. 
  
 +
=See Also=
 +
* [[System Variables]]
 +
* [[:Category:Custom Fields]]
 +
* [[XML]]
 +
* [[KML]]
  
−
<pre>- it is a <strong>Standard Organisation Field </strong></pre>
+
[[Category:Custom Fields]]

Latest revision as of 09:21, 29 August 2019


Construction warning.png Please note that this page is currently under construction. There is more information to come.


Overview

The SmartSimple platform comes with built-in code sets to help streamline the user's ability to categorize various items specific to the purpose of their instance, dependent on the vertical market they belong to or the usage or their platform. The three main built-in code sets include MeSH, NAICS and ICD.

To enable these code sets as Custom Field options, you will need Global User Administrator access. 

Description of Code Sets

Abbreviation Description Target Client  Use-Case

MeSH

(Medical Subject Headings)

MeSH includes the list of medical terms used by the National Library of Medicine (NLM) for its computerized system of storage and retrieval of published medical reports.

As a comprehensive controlled vocabulary, MeSH serves as a thesaurus that facilitates searching within the medical research market.

Medical Research
  • the classification of specific details within medical research 

Ex: Neuroimagery, animals, depression

ICD

(International Statistical Classification of Diseases and Health Related Problems)

The ICD code set, currently on its 10th revision, is a medical classification list by the World Health Organization (WHO).

It contains codes for diseases, signs and symptoms, abnormal findings, complaints, social circumstances and external causes of injury and diseases.

Independent Medical Examiners (insurance)
  • the classification of a type of injury

Ex: Chronic post-traumatic headache, drug-induced headache

NAICS

(North American Industry Classification System)

NAICS was developed as the standard for use by US, Canadian and Mexican agencies in classifying business establishments for the collection, analysis, and publication of statistical data related to the business economy.

Industry
  • the classification of the purpose of a company, enterprise, or business

Ex: Footwear store, dessert café, pay-per-view cable programming

Configuration - Essentials

All three of these code sets are accessed in your SmartSimple instance as Custom Fields. Each code set is labelled as its own standard Custom Field Type. 

Code Set Custom Field Type
MeSH Custom Field Type: Lookup - MeSH
ICD Custom Field Type: Lookup – ICD Code 
NAICS  Custom Field Type: Lookup – NAIC Codes

Each field has a lookup function that facilitates the ease of finding the desired codes.When setting the field, the user is able to search for specific codes either by writing a description of the categorization, or by the numerical code. A list of matching items will appear and the user can choose the appropriate option from the list. 

Lookup - ICD Code field, in Edit Mode
Lookup - ICD Code field, in View Mode

Enabling as Custom Field

These built-in code sets must first be enabled in order to utilize them as look up options in your system. 

 You will need SysAdmin access to enable any of these code sets as Custom Fields.

1. Click on the 9-square menu icon on the top right of your page.

2. Under the heading Configuration, select Global Settings.

082719 sysadmin globalsettings.png

3. Click on the Organizations tab.

4. Under General Settings, select Custom Fields.

082719 customfields.png

5. Click on the + icon in the top right to create a new custom field.

New field button.png

The New Custom Field page will be displayed.

6. Click into the Field Type box and scroll down until the heading Special Input Types.

082719 special codesets types.png
 

The three built-in code sets will be available to choose.

7. Select which Custom Field Type you want, fill in the remainder of the fields, and click the Save button.

For more information about filling out the fields for a new custom field, see our Custom Fields General Settings article. 

 These built-in code sets can also be enabled as custom fields through the same process on specific UTAs.

Choosing the Region of NAIC Codes

The NAIC codes will show up as a Standard Organizational Field for a company. When you enable NAIC codes as a field, you have the option to choose the region of the code: 

Naic region options.png
NAIC Region Description
US NAIC Enabling this region will allow users to select the NAIC codes related to businesses in the United States. 
Canada NAIC, English Enabling this region will allow users to select the NAIC codes in English related to Canadian businesses.
Canada NAIC, French Enabling this region will allow users to select the NAIC codes in French related to Canadian businesses. 
European NACE

NACE is the acronym used to designate the various statistical classifications of economic activities developed since 1970 in the European Union.

Enabling this region will allow users to select the NACE codes related to European businesses. 

Choose the region that the organizations of your instance will require. 

Configuration - Advanced

Using the Custom Field Import Wizard

You are able to use the custom field Import and Export features to move or copy custom fields from one entity to another (or even another instance of SmartSimple). The custom fields are exported and imported by using XML (Extensible Markup Language) format.

As the custom field ID is unique to each custom field in the system, the custom field IDs will not be copied when importing. Any newly created custom fields using the Export/Import feature will be assigned new custom field IDs. 

Use the following IDs for the built-in code sets when trying to create a custom field for that type: 

Custom Field Type Name Custom Field Type ID
Lookup - MeSH Codes 81
Lookup - ICD Codes 74
Lookup - NAIC Codes 77

For more specific information and instructions about importing or exporting the custom fields of these built-in code sets, see our custom field import/export article and the Custom Field Import Wizard article. 

Enabling KML on ICD and NAIC Custom Field

KML (Keyhole Markup Language) is a file format used to display geographic data in Earth browsers such as Google Earth, Google Maps, and Google Maps for mobile. Using a tag-based structure with nested elements sand attributes, and based on XML standard, KML allows the visual mapping of field information in your platform. 

Currently, KML can be enabled on both the Lookup - NAIC Codes and the Lookup - ICD Code custom fields. 

In order to do so, follow these steps: 

1. Click on the 9-square menu icon on the top right of your page.

052919 MenuIcon.png 

2. Click Global Settings. 

3. Select Custom Fields under the first System tab. 

4. Edit the custom field (either NAIC or ICD) that you want to enable KML on. 

5. Under General Options, select the Enable KML option.

EnableKML.png 

6. Click Save.

Fields that contain SmartSimple KML Variables will display as a View Map button in View Mode: 

KMLFieldEditMode.png KMLFieldViewMode.png
Field in Edit Mode Field in View Mode

For more information about KML, as well as various methods of enabling KML into your SmartSimple instance, please see the KML Wiki article.

Display Code Description with System Variables

For these built-in code sets, the field stores the actual ICD, MeSH, or NAIC code (i.e. G44.0). In order to display the description associated with a specific code (such as Cluster Head Syndrome for the ICD code), you can use the following syntax in a Read Only - System Variables custom field, Web Page View, or wherever else the use of system variables is appropriate:  

 @fieldname.value@

Where fieldname is the name of the Lookup - ICD Code custom field. 

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Built-in_Code_Sets&oldid=36965’