Metadata Search Requests v5.0
This documentation references PopMedNet 5.0 +
For version 4.0.3 documentation, please see PopMedNet User's Guide Version 4.0.3
PopMedNet User's Guide
Based on version 5.0
Metadata Search Requests
Metadata Search requests allow you to search information about organizations, DataMarts, registries, and requests within a network. You may define search criteria, view the search results, and download reports.
The sections below describe the general instructions for Metadata Search requests and the details of each request type and its specific parameters and reports.
General Instructions
The Metadata Search requests use the same framework as other PopMedNet requests (see Submitting Requests v5.0 for a general overview). Therefore you create the request, define its metadata, select the request parameters, and then route the request to a DataMart. Metadata Search requests may be saved as drafts, scheduled, and saved in your request list. However, unlike other PopMedNet requests, the Metadata Search requests are not distributed to data partner's DataMarts and instead are routed to and execute against a system DataMart so results return immediately.
Composing a Metadata Search request
- From the Home Page or Requests page, click New Request at the bottom of the request panel.
- Select the Metadata Search request model and then the request type to open the Request Composer page.
- Metadata Search requests contain the same request metadata header as other PopMedNet requests. Enter any request metadata information necessary. At a minimum, the request name must be specified.
- Enter the search criteria in the Search Criteria panel. The available criteria differ by request type, see the sections below for more details.
- Ensure that the System DataMart is selected and click Submit.
Viewing Metadata Search results and downloading reports
- The results page will load after the system completes the search. The available fields differ by request type, see the sections below for more details.
- The results displayed on the web Portal are an overview of the search results. There are two ways to see more details:
- To see more details about a specific request, organization, DataMart, or registry, click on its name to view its details or profile page.
- To see more details for all the results, download a report by clicking the Download These Results button and selecting the export option from the list. The available reports and the fields contained in the reports differ by request type, see the sections below for more details.
Organization Search
Organization Search requests search the Organization Profile information for each organization in the network. This information includes a description of the organization, what types of research the organization is willing to participate in, the type of data it collects, and the data models that it utilizes.
Search Criteria
If multiple search terms and/or options within those search terms are selected, they will combine to return only organizations that meet every selection criteria. For example, for a request with the search criteria of Willing to Participate in: Clinical Trials and Data Models: i2b2 and OMOP, only organizations who have specified that they are willing to participate in clinical trials and that they use both the i2b2 and OMOP data models will appear in the search results.
| Term | Description |
|---|---|
| Name | Enter text in the free text field to search for organizations with the keyword in their name. |
| Organization Description | Enter comma-separated keywords or phrases to search for organizations with the keyword or phrase in their Organization Description field. |
| Willing to Participate In | Select the checkboxes next to the options of interest to search for organizations who have specified that they are willing to participate in that type of research. |
| Type of Data Collected by Organization | Select the checkboxes next to the options of interest to search for organizations who have specified that they collected those types of data. Note that if an organization has specified that they collect a certain type of data, it does not imply that they are making that data available to the network. |
| Electronic Health Record System | Select the checkboxes next to the options of interest to search for organizations who have specified that they use, or have used, those EHR systems. |
| Data Models | Select the checkboxes next to the options of interest to search for organizations who have specified that they use those data models. Note that if an organization has specified that they use a certain data model, it does not imply that that data model is queryable within the network. |
Results
Organization Search results display the name of the organization, its acronym, its parent (if applicable), and its description. Clicking on an organization's name will direct you to its profile page.
Reports
There are 5 reports available for Organization Search results
| Report | Description |
|---|---|
| XML - Complete | An XML file containing all available metadata fields for each organization returned in the search results. This XML file is not viewable in Internet Explorer, but is in Chrome and Firefox. |
| Excel - Summary | An Excel file containing select metadata fields for each organization returned in the search results. These fields are: Name, Acronym, Contact First Name, Contact Last Name, Contact Phone, Contact Email, Description, Collaboration Requirements, and Research Capabilities. |
| Excel - Detail | An Excel file containing all available metadata fields for each organization returned in the search results. |
| CSV - Summary | A CSV file containing select metadata fields for each organization returned in the search results. These fields are: Name, Acronym, Contact First Name, Contact Last Name, Contact Phone, Contact Email, Description, Collaboration Requirements, and Research Capabilities. |
| CSV - Detail | A CSV file containing all available metadata fields for each organization returned in the search results. |
DataMart Search
DataMart Search requests search the DataMart Profile information for each DataMart in the network. This information includes a description of the DataMart, the data model that it supports, and its available data domains.
Search Criteria
If multiple search terms and/or options within those search terms are selected, they will combine to return only DataMarts that meet every selection criteria. For example, for a request with the search criteria of Data Domains: Inpatient Encounters and Outpatient Encounters and Data Models: MSCDM, only DataMarts who have specified that they have inpatient and outpatient encounters and use the MSCDM data model will appear in the search results.
| Term | Description |
|---|---|
| Data Domains Available in this DataMart | Select the checkboxes next to the options of interest to search for DataMarts who have specified that they have those data domains available. |
| Installed Model | Select the checkboxes next to the options of interest to search for DataMarts who have those request models installed. Request models control which request types the DataMart may accept queries for. For instance, if a DataMart has the SQL Distribution Request model installed it indicates that it is capable of accepting SQL Distribution requests. |
| Data Period Range | Enter years of interest into the text boxes for the start year and/or end year to search for DataMarts who have specified that their data starts on or before or ends on or after the years of interest. Select the checkbox next to the update frequency of interest to search for DataMarts who have specified that their data is updated at that frequency. Note that a DataMart can only specify one update frequency, so only one option should be selected for this term. |
| Data Models | Select the checkbox next to the option of interest to search for DataMarts who have specified that they use that data model. Note that a DataMart can only specify one data model, so only one option should be selected for this term. |
Results
DataMart Search results display the name of the DataMart, its acronym, and its description. Clicking on an DataMart's name will direct you to its profile page.
Reports
There are 5 reports available for DataMart Search results
| Report | Description |
|---|---|
| XML - Complete | An XML file containing all available metadata fields for each DataMart returned in the search results. This XML file is not viewable in Internet Explorer, but is in Chrome and Firefox. |
| Excel - Summary | An Excel file containing select metadata fields for each DataMart returned in the search results. These fields are: Name, Acronym, Organization, Contact First Name, Contact Last Name, Contact Phone, Contact Email, Description, and Collaboration Requirements. |
| Excel - Detail | An Excel file containing all available metadata fields for each DataMart returned in the search results. |
| CSV - Summary | A CSV file containing select metadata fields for each DataMart returned in the search results. These fields are: Name, Acronym, Organization, Contact First Name, Contact Last Name, Contact Phone, Contact Email, Description, and Collaboration Requirements. |
| CSV - Detail | A CSV file containing all available metadata fields for each DataMart returned in the search results. |
Registry Search
Registry Search requests search the Registry Profile information for each registry and research data set in the network. This information includes the registry/research data set classification, condition of interest, and purpose.
Search Criteria
If multiple search terms and/or options within those search terms are selected, they will combine to return only registries/research data sets that meet every selection criteria. For example, for a request with the search criteria of Classification: Disease/Disorder/Condition and Tumor and Purpose: Effectiveness, only registries and research data sets who have the classifications of disease/disorder/condition and tumor and who have the purpose of effectiveness will appear in the search results.
| Term | Description |
|---|---|
| Classification | Select the checkboxes next to the options of interest to search for registries and research data sets with those classifications specified. |
| Condition of Interest | Select the checkboxes next to the options of interest to search for registries and research data sets with those conditions of interest specified. |
| Purpose | Select the checkboxes next to the options of interest to search for registries and research data sets with those purposes specified. |
Results
Registry Search results display in a list with expand and contract functionality. Each contracted registry/research data set result displays the name of the registry/research data set and its type. When the result is expanded, information about the registry/research data set's description, URL, and classification, condition of interest, and purpose are displayed, in addition to the number of organizations and DataMarts that specified that they use that registry/research data set.
Clicking on the name of the registry/research data set will direct you to its profile page.
Request Search
Due to the detailed information included in Request Search results, this feature is currently limited to network coordinating center members.
Request Metadata Search requests search information about the requests submitted within specified project(s) in the network. Requests can be searched for by fields including project, request status, and the date range in which they were submitted. Summary Table Queries v5.0 may also be searched for by their request parameters, including codes or drug names used, clinical settings, and observation period.
Search Criteria
If multiple search terms are selected, they will combine to return only requests that meet every selection criteria. For example, for a request with the search criteria of Request Status: Completed and Submit Date Range: 01/01/2013 - 12/31/2013 , only completed requests submitted in 2013 will appear in the search results.
| Term | Description |
|---|---|
| Project | Select the project of interest from the dropdown menu to search for requests submitted within that project. |
| Request Status | Select the request status of interest from the dropdown menu to search for requests with that status. |
| Submit Date Range | Define the date range of interest using the date selectors to search for requests that were submitted within that date range. |
| Requester Center* | Select the requester center of interest from the dropdown menu to search for requests with that requester center defined. |
| Workplan Type* | Select the workplan type of interest from the dropdown menu to search for requests with that workplan type defined. |
| Task Order* | Select the task order of interest from the dropdown menu to search for requests with that task order defined. |
| Activity* | Select the activity of interest from the dropdown menu to search for requests with that activity defined. Note that Task Order must be selected before the activities for that task order will populate in the Activity field. |
| Activity Project* | Select the activity project of interest from the dropdown menu to search for requests with that activity defined. Note that Task Order and Activity must be selected before the activity projects for that task order and activity will populate in the Activity Project field. |
* Some request metadata fields are only in use on certain networks. On networks where those fields are not in use, the dropdown menus for those terms will be empty.
Summary Table Query Search Terms
| Term | Description |
|---|---|
| Code Set | Select the code set of interest from the dropdown menu. Click Select and use the Code Selector wizard to pick the codes of interest to search for requests that queried for those codes. |
| Clinical Setting | Select the clinical setting of interest from the dropdown menu to search for requests that queried for that clinical setting. |
| Sex | Select the sex(es) of interest from the dropdown menu to search for requests that queried for that(those) sex(es).
|
| Age Stratifier | Select the age stratifier of interest from the dropdown menu to search for requests that queried for that age stratification. |
| Observation Period | Define the observation period of interest using the date selectors to search for requests that queried within that observation period. |
Results
Request Search results display in a list with expand and contract functionality. Each contracted request result display the project, the request type, the name of the request, the date that it was submitted, the requester, the requester's organization, and the request ID. When the result is expanded, the information about the priority, due date, purpose of use, level of PHI disclosure, requester email, description, task order, activity, activity project, requester center, and workplan type will be displayed.
Clicking on the name of the request will direct you to its Request Details page where you may view more information, including the parameters of the request.
Reports
There are 5 reports available for Request Search results
| Report | Description |
|---|---|
| XML - Complete | An XML file containing all available metadata fields for each request returned in the search results. This XML file is not viewable in Internet Explorer, but is in Chrome and Firefox. |
| Excel - Summary | An Excel file containing select metadata fields for each request returned in the search results. These fields are: request ID, project, request type, name, submitted date, requester, requester email, description, project group, requester organization, priority, due date, task order, activity, activity project, purpose of use, level of PHI disclosure, requester center, and workplan type. Each request is displayed on a single row. |
| Excel - Detail | An Excel file containing all available metadata fields for each request returned in the search results, including DataMart routing information and activity. Each instance of a DataMart routing is displayed on a single row. |
| CSV - Summary | A CSV file containing select metadata fields for each request returned in the search results. These fields are: request ID, project, request type, name, submitted date, requester, requester email, description, project group, requester organization, priority, due date, task order, activity, activity project, purpose of use, level of PHI disclosure, requester center, and workplan type. Each request is displayed on a single row. |
| CSV - Detail | A CSV file containing all available metadata fields for each request returned in the search results, including DataMart routing information and activity. Each instance of a DataMart routing is displayed on a single row. |