Health Information Technology
Standards Panel

USHIK
HITSP Portal Quick Start Guide

Navigating the Portal:

USHIK has designated a portal specifically for HITSP research/reference. Once at USHIK (http://ushik.ahrq.gov) select the tab at the upper left of the web page named HITSP Portal. From here you may use the links on the left of the page to navigate
  • via the Information Model link (which allows you to view constructs (documents) developed by Technical Committees (TCs) using expandable columns)
    screenshot of HITSP portal describing the content of the informational model
  • via HITSP Constructs link (which will allow you to select from a list of constructs)
    screenshot of HITSP portal describing the contstructs page.
    or
  • via the HITSP Search or Advanced Search links (which allow you to conduct a search). The search may be initiated by typing the complete data elements name, partial item name, short name, alternate name, keyword, phrase, OID, context, or other properties of a data element, value set, module or construct). The result will allow you to further narrow your search and/or compare the metadata properties of each of the data elements/values sets and/or modules selected.
    screenshot of HITSP portal describing search tools.
*You may also download your results in PDF, XML, and Excel™ formats. (Further information on the comparison matrix and download metadata information is below)

Researching HITSP Constructs:

USHIK has designated a separate portal specifically for HITSP specifications. There are three ways in which you may reference / research HITSP Constructs:
screenshot of HITSP portal link
  • You may select the HITSP Constructs link on the left of the portal page, and then you may select the HITSP document that you would like to reference from an interactive list, and drill down from content, to sections/modules to the data elements and/or value sets selected within. There is a letter wheel at the bottom of each model view, that allows you to select a known data element and/or value set by the first letter of its name, or you may select all, which will make visible all data element/value sets used in that construct.
    screenshot of HITSP portal describing the content of the informational model
  • You may select the HITSP Information Model to find constructs.
    screenshot of HITSP portal describing the content of the HITSP Constructs list page
  • They are graphically placed under the expandable columns of their owner Technical Committees. For example if you know that a construct was authored by Population Perspective Committee, you may select that column in the information model; select expand all and select the construct of interest. At this time, your selection will take you to the construct (in model view) at which time you may continue your search by content, context, or data metadata (as before mentioned).
  • You may enter the name of the construct (partial or complete) into the search or advance search bar and select from the list rendered.
    screenshot of HITSP portal describing search tools.

Finding a Data Element:

  • To find a data element when you know the whole name (or at least the first part); from any page, type the first part of the name into the “Quick Search” box in the header and click “Begin Search.” The system will return any data elements beginning with that word or phrase.
    screenshot of HITSP portal describing search tools.
  • To find a data element when you know some part of the name; from any page, go to the Advanced Search via the “Search” button in the header. Type the part of the name you know into the “Component Name” box, select the radio button “Contains” underneath, and then click “Begin Search.” The system will return any data elements containing that word or phrase.
  • To find a data element by keyword: From any page, go to the Advance Search via the “search” button in the header. Type the keyword into the “definition” box, select the radio button “Contains” underneath, and then click “Begin Search.” The system will return any data elements with definitions containing that word or phrase.
  • To find similar data elements via the high-level model: Form any page, click on the header of footer button “Models”, click on NHIM, find a subject in the graphics that seems likely to be the type of element you are hunting. Click on that part of the graphic; the system will bring up the next level of the model AND any data elements mapped to that level. Continue to drill down by clicking on another model view from this page that further limits the kinds of data elements returned by subject OR choose to look at the list from the alphabetic counts or ALL.
  • To find data elements by the same Organization: From any page, click on the header or footer button “Organization”, find the Organization of interest via the letter wheel or the full list (All), click on the name of the Organization. The system will return any data element registered by that Organization,

    or
  • From any page - go to the Advance Search via the “Search” button in the header. Depending upon the relationship of the Organization to the data element (Registration Authority, Responsible Organization or Submitting Organization), select the Organization from the proper drop-down box , then click “Begin Search.” The system will return any data elements with the Organization of interest in the selected role.
  • To find data elements in the same Data Collection, Data Agreement or Initiative; from any page, click on the header or footer button “Collections” “Agreement” or “Initiatives.” Find the Data Collection, Agreement or Initiative of interest via the letter wheel or the full list (All), then click on the name of the Collection, Agreement or Initiative. The system will return any data elements registered by that Collection, Agreement or Initiative. For other Functional Groupings or Views, select the Menu Item on the left, then the grouping of interest. For requesting new Functional Groupings or Views, or for special database queries, use the “Give us your Feedback” form (icon on every page).

Finding Value Sets:

  • To find a value set where you know the whole name (or at least the first part): From any page, type the first part of the name into the “Quick Search box in the header and click “Begin Search.” The system will return any value sets beginning with that word or phrase.
    screenshot of HITSP portal describing search tools, specifically for value sets.
  • To find a value set where you know some part of the name; from any page got to the Advanced Search via the “search” button in the header. Type the part of the name that you know into the “Component Name” box, select the radio button “Contains” underneath, then click “begin Search.” The system will return any value sets containing that work or phrase.
  • To find a value set by keyword: From any page go to the Advance Search via the “search” button in the headers. Type the keyword into the “Definition: box, select the radio button “Contains” underneath, and then click “begin Search.” The system will return any value sets with definition containing that work or phrase.
  • To find similar value sets via the high-level model: From any page, click on the header or footer button “models”, click on NHIN, find a subject in the graphic that seems likely to be the type of element you are hunting. Click on that part of the graphic; the system will bring up the next level of the model AND any value sets mapped to that level. Continue to drill down b clicking on another model view from this page that further limits the kinds of value sets returned by subject OR choose to look at the list form the alphabetic counts or ALL.
  • To find value sets by the same Organization: From any page, click n the headers or footer button “Organization”, find the Organization of interest via the letter wheel or the full list (All), click on the name of the Organization. The system will return any value sets registered by that Organization.

    or
  • From any page, go to the Advanced Search via the “search” button in the header. Depending upon the relationship of the Organization to the value set (Registration Authority, Responsible Organization, or Submitting Organization), select the Organization from the proper drop-down box, and then click “Begin Search.” The system will return any value sets with the Organization of interest in the selected role.
  • To find value sets in the same Data Collection, Data Agreement or initiative: From any page, click on the header or footer button “Collections” Agreements” or “Initiatives.” Find the data Collection, Agreement, or Initiative of interest via the letter wheel or the full list (All), then click on the name of the Collection, Agreement or initiative. The system will return any value sets registered by that Collection, Agreement or Initiative.

Comparing Metadata of Data Elements: (Comparison Matrix)

screenshot of HITSP portal describing the comparison matrix report.
After finding your data element (or other data) of interest (via search, advance search), from the results rendered - select any box in the matrix to the left of the data elements (Value sets), whose metadata that you wish to compare with those of other data elements (Value sets). If all of the items you wish to compare are viewable via one screen and you have completed your search, you may click on the “Run Matrix Report” at the bottom right of the screen, however if you would like to continue your search, select “Add to Matrix Report List” and continue to add data as needed until your search in complete, at which time return to “Run Matrix Report”. You must click “Run Matrix Report” to set up the comparison matrix - an ordered array of data elements by column with the same metadata category for each element in a single row.

Comparing HITSP Specified Data Element/Value Set Metadata with other SDO metadata:

If you would like to compare the HITSP Data Element metadata to that of another SDO's data element, return to the USHIK Main Page and enter the data element name in the search engine - at which time ALL SDO data elements with “like” or exact names will return for continued comparison. (Other “like” HITSP Data Elements will be included as well - see above).

Downloading Results:

screenshot of HITSP portal describing the comparison matrix report and download features.
You may download your results via the tabs at the bottom of the page labeled Export to Excel, Export to PDF, and Export to XML. Use Select All or check the boxes next to the items that you want to export.

Referencing HITSP Documents not found in USHIK:

screenshot of HITSP portal describing links to HITSP documents not listed in USHIK.
To reference a document not registered in USHIK, a link has been provided in USHIK ( Related links: HITSP Library) which will direct you to http://www.hitsp.org. If you would like the referenced document added to USHIK, please use the “Give us your feedback” form online.

Reporting Error/Discrepancies; or requesting further assistance:

screenshot of HITSP portal describing a user feedback mechanism.
The USHIK staff welcomes input and takes pride in providing accurate information. If at any time, an error is rendered, a discrepancy identified or you are in need of additional assistance, please use the “Give your feedback” link at the bottom left of each page in USHIK. A USHIK representative will contact you as soon as possible to assist your further needs or to acknowledge the error and report as soon as it has been fixed.

Learning More about the USHIK Application:

screenshot of HITSP portal describing a user feedback mechanism.
To learn more about USHIK, inquire via the “Give your feedback” link at the bottom left of each USHIK page, which provides a “request for information” option. If you are interested in data registration and/or need direct access to the USHIK Administrative Leadership contact the individuals listed below: