VOCABULARY SERVICE (SDP-V) RELEASE 1.22 SURVEILLANCE … · Vocabulary Service (SDP-V) on how to...

0

VOCABULARY SERVICE (SDP-V)

RELEASE 1.22

SURVEILLANCE DATA PLATFORM

30 August 2019

SDP Vocabulary Service User Guide

ii

VERSION HISTORY

SDP-V Release

Drafted

By

Revision

Date

Description of Change

1.0 R. DingwellA. Gregorowicz

E. HathawayS. Irivinti

07/19/17 Initial Version

1.0 D. Pellitieri 09/27/17 Adding a description of the accessibility and compatibility features to bring document in line with 508 requirement Subpart_D_1194_41 ID 2.b.1

1.4 D. Pellitieri 11/08/17 Updating with phase 1.A sprint work

1.4 D. Pellitieri 12/20/17 Updating with groups and end of phase 1A edits

1.8 K. Hay 7/24/18 Updating with phase 2 sprint work through Release 1.8

1.15 K. Hay 3/11/19 Updating with enhancements and new features available through Release 1.15

1.22 K. Hay; D. Pellitieri 8/30/19 Updating with enhancements through Release 1.22

1.22 Ruth Dixon-Taylor 9/4/19 Updating with Figure B-3. Content Creation and Modification Workflow

TABLE OF CONTENTS

WELCOME


......................................................................................................................... 1

SDP-V GOAL ...................................................................................................................... 1

SDP-V SYSTEM OVERVIEW................................................................................................. 2

Types of Content in SDP-V......................................................................................... 3

System and Stakeholder Roles .................................................................................. 5

3.2.1 System roles and capability summary ................................................................. 5

3.2.2 Stakeholder Roles ................................................................................................ 8

GETTING STARTED........................................................................................................... 10

Accessing SDP-V ...................................................................................................... 10

Determining Roles ................................................................................................... 10

4.2.1 Collaborator (External Stakeholders) Role ........................................................ 10

4.2.2 Author ................................................................................................................ 10

4.2.3 Publisher ............................................................................................................ 10

4.2.4 Administrator ..................................................................................................... 10

How to Obtain Role-based Access .......................................................................... 11

4.3.1 Viewer ................................................................................................................ 11

4.3.2 Collaborators, Authors, Publishers, and Administrators ................................... 11

Request Collaborative Authoring Group Membership ........................................... 11

Logging In ................................................................................................................ 11

Completing User Profile .......................................................................................... 12

Logging Out ............................................................................................................. 13

Help Resources ........................................................................................................ 13

4.8.1 Help Documentation.......................................................................................... 14

4.8.2 Step-by-Step Walkthrough Tutorial ................................................................... 14

4.8.3 Application Programming Interface................................................................... 14

4.8.4 What’s New........................................................................................................ 15

4.8.5 Contact Us.......................................................................................................... 15

4.8.6 Release ............................................................................................................... 15

NAVIGATION OVERVIEW................................................................................................. 15

Dashboard Overview............................................................................................... 15

5.1.1 Search Result Details Displayed on Dashboard ................................................. 16

Response Set Details Page Overview ...................................................................... 18

Question Details Page Overview ............................................................................. 21

Section Details Page Overview................................................................................ 24

iii


Survey Details Page Overview................................................................................. 26

Content Visibility and Related Business Rules ........................................................ 28

5.6.1 Private Visibility.................................................................................................. 28

5.6.2 Public Visibility ................................................................................................... 29

5.6.3 Content Stage..................................................................................................... 31

5.6.4 Access Denied Messages ................................................................................... 31

VIEWER FUNCTIONS........................................................................................................ 32

Searching for Content ............................................................................................. 32

6.1.1 By Keyword or Phrase........................................................................................ 33

6.1.2 By Exact Match................................................................................................... 35

Filtering by Dashboard Filters ................................................................................. 35

6.2.1 Description of Dashboard Filter......................................................................... 36

Advanced Search features....................................................................................... 37

6.3.1 How to Use the Advanced Search Filters:.......................................................... 37

6.3.2 Description of Advanced Search Filters ............................................................. 39

Dashboard Search Report ....................................................................................... 41

Exporting Content ................................................................................................... 42

6.5.1 Epi Info Desktop (Surveys and Sections)............................................................ 43

6.5.2 Epi Info Web Based (Surveys) ............................................................................ 43

6.5.3 REDCap (Surveys and Sections).......................................................................... 44

6.5.4 Spreadsheet (XLSX) (Surveys only) .................................................................... 45

6.5.5 PDF (Surveys and Sections)................................................................................ 45

AUTHORING FUNCTIONS................................................................................................. 45

Creating New Content in SDP-V .............................................................................. 45

7.1.1 Creating New Response Sets ............................................................................. 45

7.1.2 Creating New Questions .................................................................................... 47

7.1.3 Creating New Sections ....................................................................................... 50

7.1.4 Creating New Surveys ........................................................................................ 54

Adding Content to Groups ...................................................................................... 55

7.2.1 View List of Groups to Which a User Belongs.................................................... 56

Adding Keyword Tags to Content............................................................................ 57

7.3.1 How to Add a Tag............................................................................................... 57

7.3.2 How to remove a tag ......................................................................................... 58

Adding Code System Mappings to Content ............................................................ 58

7.4.1 Code System Mapping Table Definitions........................................................... 58

7.4.2 How to Search for Previously Used Code Mappings ......................................... 59

iv


7.4.3 How to Create a New Code System Mapping.................................................... 59

7.4.4 How to Search for Code Mappings from an External Code Systems................. 59

Revising and Editing Content That You Own........................................................... 60

7.5.1 How to Edit Content with Private Visibility ....................................................... 60

7.5.2 How to Revise Public Content That You Own .................................................... 62

7.5.3 Change History................................................................................................... 64

Requesting that Content You Authored be Published (Made Public) Or Retired (Hidden From Dashboard Search Results)............................................................................. 65

7.6.1 Request that Content Be Published................................................................... 65

7.6.2 Request that Content be Retired....................................................................... 66

Creating a Copy of Content Created by Other Authors (Extending) ....................... 67

Commenting on Existing Content ........................................................................... 69

7.8.1 Public Comments ............................................................................................... 69

7.8.2 Private Comments.............................................................................................. 71

Importing Existing Content into SDP-V ................................................................... 73

7.9.1 How to Create a New SDP-V Survey from an Import Template ........................ 73

7.9.2 How to Populate Import Templates with Content to Create SDP-V Surveys .... 75

7.9.3 SDP-V Generic Import Template Content and Formatting Requirements ........ 85

7.9.4 MMG Import Template Content and Formatting Requirements ...................... 94

CURATION FUNCTIONS.................................................................................................... 97

Curation Wizard Algorithm ..................................................................................... 97

Curation Wizard Role-based Permissions ............................................................... 97

Using the Curation Wizard ...................................................................................... 98

8.3.1 Curation of Questions and Response Sets from Your Survey That Have Private Visibility 100

8.3.2 Curation of Published Questions and Response Sets ...................................... 102

8.3.1 Mark as Reviewed............................................................................................ 104

Viewing Curation History....................................................................................... 105

PUBLISHER FUNCTIONS ................................................................................................. 106

View Private Content in SDP-V to Identify Harmonization Opportunites Before Publishing Content............................................................................................................... 106

Publish Private Content......................................................................................... 107

Retire Published Content ...................................................................................... 108

ADMINISTRATOR FUNCTIONS ....................................................................................... 110

Admin List & Publisher List Tabs ........................................................................... 110

Author List ............................................................................................................. 111

Program List and System List Tabs ........................................................................ 111

v


Group List Tab ....................................................................................................... 112

Analytics Tab ......................................................................................................... 112

Elasticsearch Tab ................................................................................................... 113

Preferred content.................................................................................................. 113

SDP-V ERROR MESSAGES............................................................................................... 114

SECTION 508 COMPLIANCE AND ACCESIBILITY FEATURES .............................................. 115

OPERATIONAL STATUS .................................................................................................. 115

APPENDIX A: ACRONYMS .................................................................................................. 116

APPENDIX B: ROLE, CAPABILITIES, AND WORKFLOWS ........................................................ 117

LIST OF FIGURES Figure 1. SDP-V Enables Reuse of Harmonized Questions and Response Sets .............................. 1

Figure 2. SDP-V Component Diagram ............................................................................................. 4

Figure 3: SDP-V System and Stakeholder Roles Overview.............................................................. 5

Figure 4: Logging into SDP-V......................................................................................................... 12

Figure 5: User Account Setup ....................................................................................................... 13

Figure 6: Logging Out of SDP-V ..................................................................................................... 13

Figure 7. Locating User Help Resources........................................................................................ 14

Figure 8. Dashboard Overview...................................................................................................... 16

Figure 9. Dashboard Content Details............................................................................................ 17

Figure 10. Dashboard Response Set Details ................................................................................. 18

Figure 11: Dashboard Response Set Preview ............................................................................... 18

Figure 12. Response Set Details Page Overview........................................................................... 20

Figure 13. Question Details Page Overview.................................................................................. 23

Figure 14. Section Details Page Overview .................................................................................... 25

Figure 15. Survey Details Page...................................................................................................... 27

Figure 16. Content Stages Available for Content with Private Visibility....................................... 29

Figure 17. Content Stages Available for Content with Public Visibility ........................................ 30

Figure 18. Access Denied Message for Authenticated Users ....................................................... 32

Figure 19. Access Denied Message for Unauthenticated Users ................................................... 32

Figure 20. Searching for Content on Dashboard by Keyword or Phrase ...................................... 34

Figure 21. Searching for Content on Dashboard by Exact Match................................................. 35

Figure 22. Dashboard Filters ......................................................................................................... 36

Figure 23. Filtering Search Results Owned by a Specific Group ................................................... 36

Figure 24. Using Advanced Search Filters..................................................................................... 38

vi


Figure 25.Export Dashboard Search Report ................................................................................. 42

Figure 26. Exporting Content ........................................................................................................ 42

Figure 27. Populate an Epi Info Form with SDP-V Content .......................................................... 43

Figure 28.Populate a REDCap Project with SDP-V Content .......................................................... 44

Figure 29. Creating New Response Sets ....................................................................................... 46

Figure 30. Creating a New Question ............................................................................................. 49

Figure 31. Creating a New Section – Editing Section Details ........................................................ 52

Figure 32. Creating a New Section – Editing Default Question and Nested Section Properties .. 53

Figure 33. Creating a New Survey................................................................................................. 55

Figure 34. Add Content to Groups................................................................................................ 56

Figure 35. Viewing Groups to Which a User Belongs ................................................................... 56

Figure 36. Adding or Updating Keyword Tags .............................................................................. 57

Figure 37. Removing Keyword Tags.............................................................................................. 58

Figure 38. Adding Code System Mappings to Content ................................................................. 60

Figure 39. Editing Content with Private Visibility ......................................................................... 62

Figure 40. Revising Content with Published Visibility That You Own........................................... 63

Figure 41. Content Change History............................................................................................... 64

Figure 42. Requesting that Content Be Published (Made Public) ................................................ 66

Figure 43. Requesting that Content is Retired.............................................................................. 67

Figure 44. Extending - Creating a Copy of Public Content for Use ............................................... 68

Figure 45. Example of Extended Content ..................................................................................... 69

Figure 46: Posting Public Comments on Content ......................................................................... 70

Figure 47. Posting Private Comments on Content........................................................................ 72

Figure 48. SDP-V Import Menu ..................................................................................................... 73

Figure 49. Import Errors and Warnings Views.............................................................................. 74

Figure 50. View SDP-V Survey After Successful Import ................................................................ 74

Figure 51. Creating Sections in Import Template ......................................................................... 76

Figure 52. Survey Created from Import Template........................................................................ 77

Figure 53. How to Associate Response Sets with Choice Questions on Import........................... 79

Figure 54. How to Associate PHIN VADS Value Sets with Choice Questions on Import .............. 79

Figure 55. Response Set Tab in Import Template......................................................................... 80

Figure 56. Associating User-defined RS with a Question on Import Template ............................ 81

Figure 57. RS Linked to Question in UI After Import .................................................................... 81

Figure 58. New Response Set Created in SDP-V from RS Tab in Import Template ...................... 82

Figure 59. Code System Mappings Tab in Import Template ........................................................ 83

Figure 60. Associating CSM with a Question on Import Template............................................... 84

Figure 61. CSM Table Populated in UI After Import ..................................................................... 84

vii


Figure 62. Screenshot of Generic Import Template ..................................................................... 85

Figure 63. Survey Metadata Tab in Import Template................................................................... 87

Figure 64. New Survey Created in SDP-V from Import Template with Metadata Populated ...... 87

Figure 65. Section Metadata Tab in Import Template.................................................................. 89

Figure 66. New Section Created in SDP-V from Import Template with Metadata Populated ..... 89

Figure 67. Survey Questions Tab in Import Template .................................................................. 94

Figure 68. New Question Created in SDP-V from Import Template............................................. 94

Figure 69. Focus of Curation by Role ............................................................................................ 98

Figure 70. View Curation Wizard Suggestions .............................................................................. 99

Figure 71. Using the Curation Wizard to Replace Questions or Response Sets on a Private Survey ..................................................................................................................................................... 101

Figure 72. Using the Curation Wizard to Link Questions or Response Sets on a Published Survey ..................................................................................................................................................... 103

Figure 73. Content Marked as Duplicate After Using Curation Wizard to Link Published Content ..................................................................................................................................................... 104

Figure 74. Curation Wizard “Mark as Reviewed” Feature.......................................................... 105

Figure 75. Curation History Tab .................................................................................................. 106

Figure 76. Request to Publish Email ........................................................................................... 107

Figure 77. Publishing Private Content ........................................................................................ 108

Figure 78. Retiring Content in SDP-V .......................................................................................... 109

Figure 79. Locating the Administrator Panel .............................................................................. 110

Figure 80. Administrator Panel ................................................................................................... 110

Figure 81: Author List Panel........................................................................................................ 111

Figure 82: Program List on the Administrator Panel .................................................................. 111

Figure 83: Group List on Administrator Panel ............................................................................ 112

Figure 84: Analytics Tab .............................................................................................................. 112

Figure 85: Elasticsearch Management........................................................................................ 113

Figure 86: Marking Content as Preferred ................................................................................... 114

Figure 87: Error Messages .......................................................................................................... 115

viii


LIST OF TABLES

Table 1. Example Code System Mappings Table .......................................................................... 59

Table 2. Response Set (RS) Tab Column Headers Required to Create User-Defined RS on Import

Table 4. SDP-

....................................................................................................................................................... 80

Table 3. Code System Mappings Column Headers Required to Populate CSM on Import

V Generic Import: Survey Metadata Tab Column Headers Required for Information

.......... 83

to Import into SDP-V..................................................................................................................... 85

Table 5. SDP-V Generic Import: Section Metadata Tab Column Headers Required for Information to Import into SDP-V..................................................................................................................... 87

Table 6. SDP-V Generic Import: Survey Questions Tab Column Headers Required for Content to Import into SDP-V ......................................................................................................................... 90

Table 7. SDP-V MMG Import: Column Headers Required for Content to Import into SDP-V...... 95

Table 8. Curation Wizard Feature Access by Role ........................................................................ 98

ix

Template for Projects Using Agile Development

WELCOME

This document serves as a reference for users of the Surveillance Data Platform (SDP) Vocabulary Service (SDP-V) on how to use the application. It also provides background and context on the intent of SDP-V, the types of content it contains, the various user roles, and the actions users are able to take, depending on their role.

SDP-V GOAL

The goal of SDP-V is to facilitate discovery and reuse of existing vocabulary content, thereby reducing the number of different ways the Centers for Disease Control and Prevention (CDC) asks for the same type of information across programs and surveillance systems (see 1, 2 in Figure 1). This will help to reduce state, tribal, local, and territorial partner reporting burden, as well as drive toward harmonization in data collection instruments.

By making it easy for Authors to see how others have asked for certain types of information in the past, SDP-V enables Authors to spend less time creating new data collection instruments (see 3 in Figure 1). In other words, by reusing Survey Questions and other content, SDP-V can enhance consistency in how Questions are asked and answered. Not only is it easier to answer Questions asked the same way, this consistency also makes it easier for CDC to compare answers and see the big picture. This change should allow users to spend less time figuring out how to ask the right Question and spend more time doing the important work of analyzing the results.

Figure 1. illustrates how this goal can be achieved by using SDP-V. For greater clarity, this diagram is available for viewing on the SDP Vocabulary Service webpage.

Figure 1. SDP-V Enables Reuse of Harmonized Questions and Response Sets

1

https://www.cdc.gov/sdp/SDPVocabularyServiceSharedServices.html


SDP-V SYSTEM OVERVIEW

SDP-V provides a repository of Response Sets, Questions, Sections, and Surveys that allow public health professionals to discover, reuse or create, and deploy data collection instruments more rapidly. SDP-V also provides transparency across published content from multiple programs and enables use of harmonized Questions and Response Sets. This content, described in further detail in Section 3.1, is available to users via a graphical user interface and is also available to other applications through an application programming interface (API).

The capabilities and benefits of using SDP-V are summarized below:

Search and Filter to Find Existing Content Easily: Facilitates discovery and reuse of existing vocabulary content. Value sets from the Public Health Information Network Vocabulary Access and Distribution System (PHIN VADS)1 are made available to SDP-V users and are checked weekly for updates.

Leverage Expertise Across Programs and Systems: Allows users to see which programs and systems are using which content, providing insight into the context behind content’s use, and allowing users to leverage other programs’ experience and work.

Author New Content: When no existing content meets an Author’s data collection needs, SDP-V provides an interface for Authors to create new content from scratch or extend existing content. Extending means creating a copy of existing content to be used as a starting point for an Author’s own needs.

Draft Content Privately or in Collaborative Authoring Groups, then Submit for Publishing when Ready: Authors decide when their new content is ready to be submitted for Publisher review and public visibility. SDP-V keeps track of changes to draft content.

Export Groupings of Questions in SDP-V Forms and SDP-V Surveys: Leverage Vocabulary Service content and authoring capabilities to create a data collection specification for use in other data collection tools like Epi Info, REDCap, or other tools.

Integrate Vocabulary with Other Tools Through API: Leverage Vocabulary Service content and authoring capabilities to create a data collection specification for integration with other tools through API.

Import Existing Content: Reduce the time needed to acquire existing content from external Surveys, data dictionaries, and other sources into SDP-V for use and reuse using SDP-V import templates.

Search for Codes Across Several Code Systems: Enables authors to look up coded values from standards such as Logical Observation Identifiers Names and Codes (LOINC) and

1 PHIN VADS provides standard vocabularies, particularly value sets associated with H7 message implementation guides, to CDC and public health partners. More information about PHIN VADS can be found at https://www.cdc.gov/phin/tools/phinvads/index.html

2

https://www.cdc.gov/phin/tools/phinvads/index.html


Systematized Nomenclature of Medicine (SNOMED), available from the PHIN VADS2

Concept Service, for use in their Response Sets.

Maintain Version History: See the evolution of Vocabulary content from one published version to the next.

Identify Harmonization Opportunities Using the Curation Wizard: Quickly see how authors from other programs have asked similar Questions or defined Response Sets. Reuse can improve quality and reduce burden for Survey developers and data analysts alike.

TYPES OF CONTENT IN SDP-V

SDP-V serves as a repository and authoring tool for four different types of content that are consistently identified throughout the application by color and icon: Response Sets, Questions, Sections, and SDP-V Surveys. Figure 2 shows how the different types of content are related; for greater clarity, the diagram can also be viewed on the SDP Vocabulary Service web page.

These content types are defined as follows:

Response Set – A set of response choices that are applicable answers to one or more Questions.

Question – Typically a natural language expression used to solicit a value for a data variable such as, “What is your age?” In some cases, such as for defining vocabulary for electronic information exchange, this may be the data element name used to solicit a value for the data variable instead of a natural language expression, such as “Subject’s Sex.”

Section – A grouping of Questions related to a topic (e.g., demographic, clinical, laboratory, epidemiological) and intended to appear together as part of a data collection instrument. A Section may also contain one or more Sections (e.g., sub-Sections or nested Sections) such as “Symptom” and “Diagnosis” Sections within a “Clinical” Section.

SDP-V Survey – A SDP-V Survey defines the vocabulary (e.g., Questions and Response Sets) used for a particular data collection or information exchange. An SDP-V Survey contains one or more Sections that are consolidated and intended for a data collection instrument or information exchange.

2 PHIN VADS provides standard vocabularies, particularly value sets associated with H7 message implementation guides, to CDC and public health partners. More information about PHIN VADS can be found at https://www.cdc.gov/phin/tools/phinvads/index.html

3

https://www.cdc.gov/sdp/SDPHowItWorksVocabularyService.htmlhttps://www.cdc.gov/phin/tools/phinvads/index.html


Figure 2. SDP-V Component Diagram

4


SYSTEM AND STAKEHOLDER ROLES

SDP-V has five defined user roles that allow access to specific content and capabilities as shown in Figure 3. These roles, defined below, are Viewer, Collaborator, Author, Publisher, and Administrator. In addition to these roles, a user can belong to a collaborative authoring group. Additional stakeholder roles include the SDP-V User Group, CDC Programs, and the SDP Program. Please see

Appendix B: Role, Capabilities, and Workflows for role, capabilities, and work flowcharts.

Figure 3: SDP-V System and Stakeholder Roles Overview

3.2.1 System roles and capability summary

Viewer (Public)

The SDP-V is accessible to the public. Anyone may browse published content in the Vocabulary Service by visiting the SDP-V web page.

Viewer Capabilities

A summary of capabilities available to Viewers in SDP-V is as follows.

Browse, search, and view details of all content published by an SDP-V Publisher.

Export published content.

Collaborator (External Stakeholder)

Collaborators are external public health partners who are interested in developing vocabulary with CDC Programs.

Collaborator Capabilities

A summary of capabilities available to Collaborators in SDP-V is as follows.

5

https://sdp-v.services.cdc.gov/#/


Comment on public content.

Browse, edit, and comment on private content that is in a collaborative authoring group (CAG) to which they belong.

Export private content that is in a CAG to which they belong to Excel, REDCap, or Epi Info.

Author (Authenticated User)

CDC Programs identify SDP-V Authors as users expected to add, edit, revise, or curate program content. To become an SDP-V Author, users go through a CDC SDP-V onboarding process to obtain the needed credentials. The SDP program calls this becoming an “Authenticated User.” Users interested in becoming an Author should contact the SDP program (see Section 4.8.5). Though it is not required, an Author may be a member of one or multiple CAGs.

Author Capabilities

The following capabilities are available to Authors in SDP-V:

Browse, search, and view details of all content published by an SDP-V Publisher.

Browse and edit their own private content.

Browse and revise their own published content.

Add content to CAGs.

Create new content (private content until published).

Import content (Message Mapping Guide [MMG] or SDP-V template format).

Browse and extend published content. Extending content creates a copy of published content to use as a starting point for an Author’s own content. Extending content creates a private copy that includes a link to the content from which it was extended for traceability.

Export content to Excel, REDCap, or Epi Info.

Request that an SDP-V Publisher publish private content.

Author Expectations and Best Practices

There are several expectations and best practices for the Author role to maximize the value of SDP-V.

Authors are expected to reuse existing SDP-V content, when possible, to reduce variability and evolve toward harmonization. Where reuse is not practical, Authors should document a justification to share with Publishers.

When creating new Questions, Sections, and Surveys, Authors are expected to use Tags (see Section 7.1) whenever possible to make it easier for others to search for and reuse content.

Authors should verify that the Program and Surveillance System associated with their account in SDP-V (see Section 4.6) is accurate when they are creating new content. This is to ensure that the association between SDP-V

6


content and Programs and Surveillance Systems remains accurate. This association between content and the Program and System using it helps other users of the system to better understand the context in which existing SDP-V content is used and make informed decisions to reuse content for their own data collection needs.

Authors should include at least the following in a request for private content to be published:

o Whenever a Response Set or Question is extended, describe why the original content did not meet the Author’s needs. This context could be valuable to other users (e.g., reading level, culturally preferred term, etc.).

o A need-by date for publishing the private content.

The Author will work with their Publisher to ensure that any content that they solely own will be appropriately transitioned to another user if the Author plans to stop using SDP-V or leave CDC.

Publisher (Authenticated User with Publisher Role)

CDC Programs identify SDP-V Publishers as users expected to review SDP-V Survey publication requests for their program area to ensure that the proposed vocabulary is harmonized to reduce redundancy, in addition to adding, editing, revising, or curating program content. Publishers are authenticated SDP-V users (i.e., Authors) who have been granted the Publisher role. The Publisher is a designated role with distinct and elevated privileges to see all private content in the service. In general, Publishers are individuals who have expertise with Surveys, vocabularies, public health standards, and the program they support. They have expertise in content needed to perform surveillance for a condition or set of conditions. Publishers are responsible for SDP-V content for a single program but should have a cross-program awareness of related content to encourage cross-program harmony.

SDP-V Authors who are interested in becoming Publishers should contact either the appropriate CDC program with their request or the SDP program for further assistance (see Section 4.8.5). At least one Publisher is identified when a program commits to using SDP-V.

The following capabilities are available to Publishers in SDP-V:

Publisher Capabilities

Browse and search all private content.

Publish content that is in a private state, regardless of the Author of that content. The act of “publishing” in SDP-V makes content visible to unauthenticated users (e.g., public visibility).

Retire published content.

All Author capabilities

Publisher Expectations and Best Practices

7


There are several expectations and best practices for Publishers to maximize the value of SDP-V.

Ensure quality of Questions and Response Sets, and ensure that Authors use pre-existing authoritative Response Sets (e.g., those synchronized from PHIN VADS) where possible.

Ensure harmony of content within the assigned program.

Encourage harmony across content for multiple programs.

Be responsive to Author publish requests.

Inform Authors of status of publish requests via email.

Administrator (Authenticated User with Admin Role)

SDP-V Administrators are identified by the SDP Programs. Administrators are authenticated SDP-V users (i.e., Authors) who have been granted the Admin role. Administrators are individuals who perform various platform tasks and maintenance on behalf of SDP-V. They may add/delete CAGs, add users to CAGs, add and assign roles (e.g., Publisher) to users, and add new programs and systems.

SDP-V Authors who are interested in becoming Publishers should either contact the appropriate CDC program with their request or contact the SDP program for further assistance (see Section 4.8.5).

Administrator Capabilities

The following capabilities are available to Administrators in SDP-V:

Access to an Admin Panel page (more detail in Section 10)

Ability to manage and curate the list of Admins, Publishers, Programs, and Systems currently in the system

Ability to curate the list of collaborative authoring groups and group membership lists

Ability to mark content as “CDC Preferred”

Administrative tasks involving synchronization of Elasticsearch


All Publisher capabilities

Administrator Expectations and Best Practices

Identify a designated backup for when the Administrator is unavailable.

3.2.2 Stakeholder Roles

Collaborative Authoring Groups (CAGs)

SDP-V allows a user with the Administrator role to create groups of authors. A group should be created if multiple Authors need to view and collaborate on content that is private (see Section 5.6); otherwise, only the original Author would be able to view the content prior to publication. Once added to a CAG, an Author can add or remove content that they have created to the group. Other members of the group will subsequently have all the same

8


abilities to edit, revise, and maintain that content as the original Author does. Groups allow Authors to collaborate with other Authors while creating and revising content. For details on how to add content to a group, see Section 7.2.

Collaborative Authoring Group Capabilities


Share private content with group members

SDP-V User Group

A user group consists of users and potential adopters who meet frequently with the SDP-V product owner to provide feedback on current SDP-V capabilities, new requirements, mock-ups, and priorities.

SDP Program

The SDP Program is responsible for providing all the necessary support to ensure that SDP-V meets users’ needs. These responsibilities include, but are not limited to, providing technical expertise and help desk support, ensuring that dependencies such as infrastructure meet SDP-V needs, ensuring that funding is commensurate with resource needs, supporting SDP-V technical and development efforts, and developing appropriate processes for onboarding, change control, governance, etc.

CDC Programs

CDC Programs are defined as CDC Center, Institute, and Office-funded programs, research, and activities. CDC Programs provide SDP-V users and members of Harmonization Working Groups expertise on domain-specific vocabulary. During SDP-V onboarding, programs will designate a representative to be the program Publisher, who is responsible for ensuring the quality of the content and encouraging harmonization activities among program Authors in SDP-V.

9

ETTING STARTED

his Section serves as a quick reference for basic a ccess and account configuration actions.

ACCESSING SDP-V

SDP-V is accessible via a web browser by visiting: https://sdp-v.service.cdc.gov.

A user account is not required to browse, search, and view content that has been published in the service. A user account is required to author content or view content that s in private visibility status. In formation on registering as a user is in Section 4. nformation on accessing the content in the service via a Representational State Transfer RESTful) API is in Section 4.8.3.

DETERMINING ROLES

f you are unsure of the appropriate role to request, contact the SDP Program team.


4.2.1 Collaborator (External Stakeholders) Role

Public health partners who are interested in working with CDC programson the development of vocabulary within the Vocabulary Service shouldtalk to their CDC program partners about becoming collaborators in theVocabulary Service. Your CDC program partner will identify appropriateCAGs to which you belong. If you are uncertain who to contact, contactthe SDP program (see Section 4.8.5) for assistance.

4.2.2 Author

To become an SDP-V Author, CDC users should work with their program leadership to request the ability to author content. If you are uncertain who to contact, contact the SDP program (see Section 4.8.5) for assistance.

4.2.3 Publisher

Because Publishers have the important duty of ensuring quality and encouraging harmonization, they are identified when a CDC program commits to using SDP-V to author Questions and Response Sets needed to address their data collection needs. The SDP program calls this “program onboarding.” SDP-V Publishers are normally designated by the associated CDC program during the program onboarding process. After this onboarding process, changes to Publishers can be made by sending an email request to the SDP program (see Section 4.8.5).

4.2.4 Administrator

Administrator privileges are assigned selectively at the service level due to the responsibilities associated with admin users. Administrators are individuals who perform various service tasks and maintenance on behalf of SDP-V. These users must be approved by the SDP-V team. A request for the Administrator role should be made only if a user requires the abilities outlined in Section 10.

10

4 G

T

4.1

iI(

4.2

I

https://sdp-v.service.cdc.gov/


HOW TO OBTAIN ROLE-BASED ACCESS

4.3.1 Viewer

If your only need is to view, search, and export public SDP-V content, you may simply follow the access instructions in Section 4.1 to get started. A user account is not required to be a Viewer. If you require access to more functions or content, please see details below for how to request role-based privileges.

4.3.2 Collaborators, Authors, Publishers, and Administrators

1. Confirm that you have a Secure Access Management Service (SAMS) account. If you do not have a SAMS account, you will need to complete the SAMS identify verification process.

2. Request Surveillance Data Platform Vocabulary Service SAMS Activity Group membership. Please allow time for your request to be reviewed and approved.

o Authentication to the SDP-V service is provided via the SAMS.3 If you receive an error message after entering your credentials into SAMS, please email [email protected] to confirm your Surveillance Data Platform Vocabulary Service SAMS Activity Group membership.

REQUEST COLLABORATIVE AUTHORING GROUP MEMBERSHIP

Determine which CAGs to which you should belong or that need to be created so that group permissions can be established. Send information to [email protected]. Please allow time for your request to be reviewed and approved. You cannot be added to a CAG until after you have validated your account by logging into the Vocabulary Service once (Section 4.5).

LOGGING IN

Once you access SDP-V via your browser at https://sdp-v.services.cdc.gov/#/, click the Login button at the top right of the screen as shown in Figure 4. You will be redirected for authentication through the SAMS portal. Upon authenticating via SAMS, you will be redirected back to the SDP-V Service and logged into the system, provided you have been added to the Surveillance Data Platform Vocabulary Service SAMS Activity Group.

3 For more information about SAMS, please visit https://auth.cdc.gov

11

mailto:[email protected]:[email protected]://sdp-v.services.cdc.gov/#/https://auth.cdc.gov/


Figure 4: Logging into SDP-V

Note: If you receive an error message after entering your credentials into SAMS for the first time, please email [email protected] to request Surveillance Data

Platform Vocabulary Service SAMS Activity Group membership

COMPLETING USER PROFILE

Users of SDP-V can associate the program and surveillance system they support with their SDP-V account. This information will populate metadata in the system regarding which programs and surveillance systems are using particular content. A user may select and change the program and system selection at any time via the application’s Settings menu. If a user is collaborating with other users and creates a Survey that should be associated with a surveillance system or program that is different from the default values stored in the user’s profile, those changes can be made on the Survey Edit page (see Section 7.1.4).

To select a user’s default Program and Surveillance System:

1. Click on the drop-down menu with the user’s account name in the top-right corner of the application. Select “Settings” to bring up the account details dialog window.

2. Select the Program and Surveillance System the user supports by clicking on them in the list. Search for Programs and Surveillance Systems by name by typing in search keywords in the “Search Programs…” or “Search Systems…” text boxes, respectively. Data from user settings will be applied as the default to populate system and program values whenever Surveys are created in the system. These can be modified at any time by going to the user settings.

a. If the System or Program to which content is to be associated is not listed or if inactive Systems or Programs are identified, contact the SDP program to request that the list be updated (see Section 4.8.5). It is important for the accuracy of this list to be maintained.

3. Click “Update” to confirm the user selections. Figure 5 depicts how the screens and prompts will look like.

12

mailto:[email protected]


Figure 5: User Account Setup

LOGGING OUT

To log out of the application:

1. Click on the drop-down menu with the user account name in the top-right corner of the application.

2. From the drop-down menu, click the “Logout” option as shown in Figure 6. Logging out will return the screen to the SDP-V Dashboard. Logging out also refreshes the application, clearing any cached search history or path history.

Figure 6: Logging Out of SDP-V

HELP RESOURCES

The help menu as shown in Figure 7, provides links to the following resources and can be accessed without logging into the application.

13


Figure 7. Locating User Help Resources

The following resources are available on the help menu:

4.8.1 Help Documentation

The in-app help documentation is organized by topic area. It includes links to external resources and a brief glossary.

4.8.2 Step-by-Step Walkthrough Tutorial

The step-by-step walkthrough visually walks a user through the basic features of a page step by step.

To start a walkthrough tutorial: 1. Navigate to the page of interest (from the pages listed below). 2. Click the Help menu. 3. Click “Step-by-Step Walkthrough.”

A walkthrough can be initiated from the following pages:

Dashboard Response Sets - Create, Edit, and Details Pages Questions - Create, Edit, and Details Pages Sections - Create, Edit, and Details Pages Survey - Create, Edit, and Details Pages Code System Mappings Table on Question, Section, and Survey Edit Pages Help Page

4.8.3 Application Programming Interface

The Vocabulary Service provides a custom JSON RESTful API with Swagger documentation and testing software and Fast Healthcare Interoperability Resources (FHIR) compliant API to allow developers to create programs that can directly use information from the Vocabulary Service. API users can also access a limited set of aggregated usage metrics at the “/api/metrics” endpoint. Documentation and interactive testing tools for the SDP-V API and FHIR API can be accessed via the help menu.

Additionally, the Swagger documentation provided on the site can be used by software development tools to generate source code to access the service. To see a list of environments supported by the Swagger code generation environment, visit https://swagger.io/swagger-codegen/.

14

https://swagger.io/https://swagger.io/https://sdp-v.services.cdc.gov/#/fhirDochttps://swagger.io/swagger-codegen/


4.8.4 What’s New

“What’s New” provides the latest news and information about the CDC Vocabulary Service, including the latest release notes to learn how the application is continuously improving, learn about updates to user documentation, and find other announcements important to the user community.

4.8.5 Contact Us

Contact the SDP team via email at [email protected] or via the “Contact Us” link in the application.

The SDP Team provides assistance and guidance in the following topic areas:

Access Requests (SDP-V, SharePoint) Authorization Errors (Password Resets) General Information (How To, Inquiries, Support, Other) Feedback and Concerns Onboarding Support for New Users Partnering with SDP Report an Issue (Bugs, Performance, Publishing, Site Unavailable) Service Ticket Follow-ups User Support / Additional Training

4.8.6 Release

The help menu displays the version of the application that is currently deployed.

NAVIGATION OVERVIEW

DASHBOARD OVERVIEW

When the SDP-V application opens, the SDP-V Dashboard screen, pictured in Figure 8, appears. At the top of each SDP-V page is a navigation header. Depending on the user’s role (Viewer, Author, Publisher, or Administrator), the options visible in the navigation header will differ. Unauthenticated users will only see a Login button and Help menu. If a user is logged in as an Author, Publisher, or Administrator, from left to right the options will be:

Button to navigate back to the Dashboard

Drop-down menu to create different types of content (see Section 7)

Alerts if others have commented on the user’s public content (see Section 7.8.1)

Settings menu (drop-down from the user’s username) (see Section 4.6)

Help menu (See section 4.8)

The Dashboard also contains:

Search bar (see Section 6.1)

Dashboard filters (see Section 6.2)

Advanced filter options (see Section 6.3)

Search results

15

mailto:[email protected]


Response Set Preview (Questions only)

Dashboard search result report download (see Section 6.4)

“Matched on fields” for search results. When a user searches on the dashboard, the search results will display a list of fields on the result that match the search query. This shows the reason the result was returned even if the summary widget, which is limited to displaying the content title and description, does not display the field matched (such as tags or code system mappings).

More information about search functionality in SDP-V can be found in Section 6.1.

When navigating between pages in SDP-V, you may use the back button in the browser or the Back-arrow buttons within the application to go back to the previous page.

Figure 8. Dashboard Overview

5.1.1 Search Result Details Displayed on Dashboard

Each piece of content (Response Sets, Questions, Sections, and Surveys) in SDP-V is represented in search results by a content widget (as shown in Figure 9). Content widgets give the following information:

The content type indicated by the icon and color (see Section 3.1).

16


Content title and description

a. Clicking on either the Content title or the “eye” icon at the top right of the widget allows the user to navigate to the details page for the content.

Usage defined as the number of Programs and Systems associated with the content on a public SDP-V Survey. This is not shown on SDP-V Survey widgets.

Content maturity stage (Draft, Comment Only, Trial Use, Published, Retired, or Duplicate) of the content type (see Section 5.6.3).

The creation date, version number, and content type.

Clicking on the “Linked Item” bar at the bottom of the widget expands this part of the widget to display additional information about linked content (see Figure 2).

o Response Sets may contain responses.

o Questions may be linked to Response Sets.

o Sections may contain Questions or nested Sections.

o Surveys may contain Sections.

Indicator of “CDC Preferred” (See Section 10.7). If the content is not preferred, no icon will be visible.

Figure 9. Dashboard Content Details

Response Set Results on Dashboard

In addition to the details described in section 5.1.1, the Response Set widgets, shown in

Figure 10, also show the Response Set source (e.g., from PHIN VADS or created by an author in SDP-V [e.g., local]).

17


Figure 10. Dashboard Response Set Details

Question Results on Dashboard

As shown in Figure 11, in addition to the details described in section 5.1.1, users can also preview Response Sets linked to questions on the dashboard by clicking the “preview” button on the right side of the linked content expansion. The preview will display the first ten responses in the response set.

Figure 11: Dashboard Response Set Preview

RESPONSE SET DETAILS PAGE OVERVIEW

Each Response Set details page, as shown in Figure 12, contains the following:

Content maturity stage (Draft, Comment Only, Trial Use, Published, Retired, or Duplicate) listed in the header and details box.

Version history with content maturity stage specified in parentheses

Action buttons that will vary depending on the user’s role and the content’s visibility (publication status).

18


Response Set name, version, author, and tags

Response Set details and change history. The change history tab can only be viewed by the Author or assigned CAGs (see Section 7.5.3). Response details include:

o Version-independent ID for API.

o Description.

o Created date.

o Import/Source: If from PHIN VADS, a hyperlink to the PHIN VADS value set details page is displayed; if a user created the Response Set in SDP-V, “Local” is displayed.

o Content Stage: Draft, Comment Only, Trial Use, Published, Retired, or Duplicate (see Section 5.6.3).

o Visibility: Private or Public (see Section 5.6).

o Object identifier (OID): Included if PHIN VADS value set.

o Published by: A username will be displayed for local Response Sets if visibility is public.

o Extended from: Provides a link to the Response Set that was copied and modified to create the Response Set being viewed (see Section 7.7).

Response table

Linked Questions, which displays the Questions that are linked to this Response Set in SDP-V (similar to parent items)

Number and list of Programs and Systems using the Question on a public SDP-V Survey

Public comments (see Section 7.8.1)

Information buttons define key attributes

19


Figure 12. Response Set Details Page Overview

20


QUESTION DETAILS PAGE OVERVIEW

Each Question details page, as shown in Figure 13, contains the following:


Version history with content maturity stage specified in parentheses.

Action buttons that will vary depending on the user’s role and the content’s stage and visibility.

“Breadcrumb” trail that shows the navigation path to the current content.

Question name, version, author, and tags.

Question details and change history. The change history tab can only be viewed by the Author or assigned CAGs (see Section 7.5.3). Question details may include:

o Version-independent ID for API. o Description. o Created date. o Content Stage: Draft, Comment Only, Trial Use, Published, Retired, or

Duplicate (see Section 5.6.3). o Visibility: Private or Public (see Section 5.6). o Published by: A username will be displayed if visibility is public. o Question Category: Clinical, Demographics, Treatment, Laboratory,

Epidemiological, Vaccine, or Public Health Emergency Preparedness & Response.

o Question Subcategory: The following are allowed values for the “Epidemiological” category: Travel, Contact or Exposure, Drug Abuse, or Sexual Behavior. The following are allowed values for the “Emergency Preparedness” category: Managing & Commanding, Operations, Planning/Intelligence, Logistics, and Financial/Administration.

o Response Type: The 14 allowed response types are defined by the FHIR project.

o Data Collection Methods: The Data Collection Method attribute should represent the manner in which the Question is used to collect data at the time of administration. This is not necessarily the same as how CDC is receiving the data. Values include electronic (e.g., machine to machine), record review, self-administered (web or mobile), self-administered (paper), Facilitated by Interviewer (phone), and Facilitated by Interviewer (in person).

o Other Allowed: For choice-type Questions, indicates if “other” is an allowed option where a respondent can provide their own answer outside of the chosen Response Set.

o Extended from: Provides a link to the Question that was copied and modified to create the Question being viewed (see Section 7.7).

Code System Mappings table (see Section 7.4).

21

https://www.hl7.org/fhir/valueset-item-type.htmlhttps://www.hl7.org/fhir/valueset-item-type.html


Parent Items, which show the Sections and Surveys the Question is being used on in SDP-V.

Links to Response Sets associated with the Question.

Usage defined as the number of Programs and Systems using the Question on a public SDP-V Survey.

Public Comments (see Section 7.8.1).

Responses expected for this question. When a user navigates to the question details page from a section or survey details page, this header is displayed. This shows the response set that is used to collect data for that question in the context of a specific Survey. This is important since SDP-V allows users to associate different Response Sets with the same question on different Surveys.

Information buttons define key attributes.

22


Figure 13. Question Details Page Overview

23


SECTION DETAILS PAGE OVERVIEW

Each Section details page, as shown in Figure 14, contains the following:



Action buttons that will vary depending on the user role and the content’s stage and visibility.

“Breadcrumb” trail that shows the navigation path to the current content.

Section name, version, author, and tags.

Section details and change history. The change history tab can only be viewed by the Author or assigned CAGs (see Section 7.5.3). Section details may include:

o Version-independent ID for API. o Description. o Content Stage: Draft, Comment Only, Trial Use, Published, Retired, or

Duplicate (see Section 5.6.3). o Visibility: Private or Public (see Section 5.6.) o Published by: A username will be displayed if visibility is public.

Extended from: Provides a link to the Section that was copied and modified to create the Section being viewed (see Section 7.7).


Links to the Questions and Sections that are contained in the Section.

Program-Defined Variable: Program-Defined Variable Name can only be added to Questions from the Section edit page. The purpose of this is to allow each program to use its local program variable names to identify a Question, such as those used in data analysis by a program, without changing the properties of the Question itself. This way, the same Question can be used by multiple programs even if the program-defined variable names are different.

Parent Items that show which Sections and Surveys the Section is being used on in SDP-V.

Public comments (see Section 7.8.1).


24


Figure 14. Section Details Page Overview

25


SURVEY DETAILS PAGE OVERVIEW

Each Survey details page, as shown in Figure 15, contains the following:



Action buttons that will vary depending on the user role and the content’s stage and visibility.

Survey name, version, author, and tags.

Survey details and change history. The change history tab can only be viewed by the Author or assigned CAGs (see Section 7.5.3). Question details may include:

o Office of Management and Budget (OMB) Control Number and OMB Approval Date (if available).

o Version-independent ID for API. o Description. o Content Stage: Draft, Comment Only, Trial Use, Published, Retired, or

Duplicate (see Section 5.6.3). o Visibility: Private or Public. o Published by: A username will be displayed if visibility is public (see Section

5.6). o Extended from: Provides a link to the Survey that was copied and modified

to create the Survey being viewed (see Section 7.7).


Links to Sections that are contained in the Survey.

Public Comments (see Section 7.8.1).


26


Figure 15. Survey Details Page

27


CONTENT VISIBILITY AND RELATED BUSINESS RULES

SDP-V content can have either private or public visibility. This allows users to control who can see their content during different stages of maturity (see Section 5.6.3). Once content is made public by the Publisher (referred to as “publishing”), it cannot be undone. This is because once a version of content is made public, public health users may start to reference it for use. SDP-V uses version history and content stage to make sure users are aware of any changes that have been made to the content once it has been made public.

5.6.1 Private Visibility

When content is created or imported in SDP-V, it is created with private visibility. Private content is only visible to the user who authored it, users who belong to a group to which the content is added, and all Publishers in the system. Content with this visibility can be modified until the Author or authoring group is ready to make the content public (see Section 5.6.2).

Ability to Modify Content: Only the Author or CAG members may make changes to content with private visibility. This content can be edited as desired until it is ready to be sent to a Publisher for review. SDP-V tracks changes to private content on the Change History tab (see Section 7.5.3).

Content Stages: Users can use the “draft,” “comment only,” or “trial use” content stages for content with private visibility as shown in Figure 16. The “draft” content stage is the default stage assigned to private content; “trial use” and “comment only” are optional content stages that may be used for private content to support individual program vocabulary development workflows. These content stages may be used in any order and changed as often as necessary by the Author(s). There is no enforced workflow within SDP-V related to content stages until the content is published; this flexibility will allow programs to construct workflows that support their vocabulary development needs.

28


Figure 16. Content Stages Available for Content with Private Visibility

5.6.2 Public Visibility

Whenever an Author or authoring group is ready to share their content publicly, they must send a request to their program Publisher to change the visibility in SDP-V. Content must be reviewed and approved by a Publisher in SDP-V to change the visibility to public; this action is known as “publishing” in SDP-V. Public content is visible to everyone who visits the SDP-V website, including users without authenticated accounts. This allows Authors to share their SDP-V content with a wide public health audience. Once a version is made public, it cannot be undone. An Author can use the content stage attribute to indicate the maturity of a specific version of content and can create a new version when necessary. Authors can request that public content be “retired,” which hides the content from dashboard search results (see Section 0).

Ability to Modify Content: Only the Author or CAG members may revise public content. Revising public content results in a new private version of the content that can be modified as described above until it is ready to be published. SDP-V maintains a version history for public content so that users can see how content has evolved over time.

Content Stages: Authors can use the “published,” “comment only,” or “trial use” content stages as shown in Figure 17. The “published” content stage is the default stage for public content; “trial use” and “comment only” are optional content stages that may be used for public content to support individual program

29


vocabulary development workflows. To support multiple business cases, the author may place public content into these three content stages in any order (e.g., comment only, trial use, comment only, published) or may use only the “published” content stage. Authors who would like to retire content should contact their program publisher (see Section 0).

Figure 17. Content Stages Available for Content with Public Visibility

Note: Content with public visibility indicates that a program is ready to share content widely that may not be authoritative to promote transparency, harmonization, standardization, and the goals of SDP-V. Users interested in using public content are encouraged to reach out to the appropriate program or system users with any Questions about content and consider the indicated content stage as part of their decision to use it.

30


5.6.3 Content Stage

Content stage is an attribute of the content being presented that represents content maturity. Response Sets, Questions, Sections, and Surveys added to SDP-V do not need to advance through each content stage described below before sharing their content publicly (as described above). The content stage attribute offers Authors flexibility to communicate the maturity of their content at different stages of the vocabulary life cycle with other users.

DRAFT – Content is being worked on by its Authors and Publisher. It is generally not considered to be complete and is unlikely ready for comment. This is the initial status assigned to newly created content. Content at this level should not be used to support public health response.

COMMENT ONLY – Content is being worked on by its Authors and Publisher. It is generally not considered to be complete but is ready for viewing and comment. Content at this level should not be used to support public health response.

TRIAL USE – Content that the Authors and Publisher believe is ready for user viewing, testing, and/or comment. It is generally complete but not final. Content at this level should not be used to support public health response.

PUBLISHED – A publicly available version of content that is ready for viewing, downloading, comments, and use for public health response.

RETIRED – Content that is no longer the most recent version (not latest). However, this content could be used with no known risk.

This content stage can be used for content that has public visibility. Only Publishers can move content to this content stage and may do so only when the Author of the content requests it. Authors who would like to retire content should contact their program Publisher. Content that is retired is hidden from dashboard search results by default unless an advanced filter is toggled to show retired content.

DUPLICATE – Content that the Author and Publisher believe is either syntactically or conceptually a duplicate of other content in the SDP-V repository. Content marked as “Duplicate” should not be used when creating new SDP-V Surveys. If content marked as “Duplicate” is used on an existing SDP-V Survey, it should be replaced during the next revision.

This content stage is assigned whenever users curate their public Surveys using the curation wizard. This content stage cannot be assigned by users outside of the curation wizard.

5.6.4 Access Denied Messages

As described in section 5.6.1, private content is only visible to the user who authored it, users who belong to a group to which the content is added, and all Publishers in the system. Private content that a user does not have access to will not appear on dashboard

31


search results, but the name of private content (Response Set, Questions, or Sections) may appear in the Parent Links window to maximize identification of harmonization and reuse opportunities. If a user discovers private content of interest while viewing the Parent Links window, the message provides contact information to promote collaboration and identification of potential harmonization opportunities while content is still being drafted. Depending on the user’s role, the level of contact information displayed differs.

When a user is browsing content in the repository but does not have access to a resource, they are given instructions to contact either the Author/group owner of the content or the [email protected] account, depending on the type of access and level of permissions they have in the system. The “access denied” message is updated for authenticated and non-authenticated users to promote collaboration on private content.

Authenticated Users

If an authenticated user clicks on content they do not own or if they are not a member of a CAG to which that content belongs to, the “access denied” message reveals the name and email address of the content’s author as shown in Figure 18.

Figure 18. Access Denied Message for Authenticated Users

Unauthenticated Users

f an unauthenticated user clicks on private content, the “access denied” message revealhe [email protected] email. This provides the user with information t

I s t o request access to the SDP-V as shown in Figure 19.

Figure 19. Access Denied Message for Unauthenticated Users

VIEWER FUNCTIONS

The following sections contain detailed step-by-step instructions along with screenshots to walk a user through how to use SDP-V capabilities.

SEARCHING FOR CONTENT

The SDP-V Dashboard is the first screen presented to a user when opening the application. Users can access the dashboard at any time by clicking the “Dashboard” button in the header of the application, as detailed in Section 5.1.

32

mailto:[email protected]:[email protected]


6.1.1 By Keyword or Phrase

From the SDP-V Dashboard, users can search for content by keywords or phrases as shown in Figure 20.

Add a keyword or phrase to the search input field. While typing, a drop-down list of suggestions based on the names of items in the

system may display to assist with content discovery (see the screenshot below).

Click on the Search icon or hit the Enter key.

The list of Search Results below the search input field will be updated to reflect the search terms.

The results are prioritized by relevance (see details below). Items in the result set are sorted by CDC preferred content first, and then items with the same relevance are sorted by the number of unique systems that are using the item on published Surveys and version number. The search term is highlighted wherever it appears in the name and description of the search results, and all fields with matches to the search query are listed in the “Matched on fields:” list.

33


Figure 20. Searching for Content on Dashboard by Keyword or Phrase

Keyword and Phrase Search Attributes and Weights

Whenever entering a query, relevance is determined by the number of times a search term shows up in the search attributes, as well as the weight of those attributes. The following content attributes are included in search and will be highlighted and scored. If an attribute is weighted (the score of the match is multiplied by the weight modifier) more than others, it is listed below:

Name (weight: 9) Description (weight: 8) Code System Mapping Table Values (weight: 7)

o Concept Name o Concept Identifier o Code System Identifier

Response Set Table Values (weight: 7)

34


o Display Name o Response o Code System Identifier

Keyword Tag List (weight: 9) Category Subcategory User email address Author name Visibility status Content Stage PHIN VADS Value Set OID (weight: 20) OMB Control Number (weight: 20) Version-Independent ID

6.1.2 By Exact Match

From the SDP-V Dashboard, users can search for content by exact keywords or phrases as shown in Figure 21.

1. Add an exact keyword or phrase to the search input field enclosed in double quotes (e.g., “pregnancy”).

2. Click on the Search icon or hit the Enter key.

Figure 21. Searching for Content on Dashboard by Exact Match

FILTERING BY DASHBOARD FILTERS

SDP-V allows search results to be filtered by several attributes from the dashboard as shown in Figure 22.

To filter search results on the dashboard:

Select the desired filter

o If a user is not logged in, the following filters are available: Type (e.g., Response Sets, Questions, Sections, or Surveys) or Stage.

o If a user is logged in, the following filters are available: Type, Stage, Owner, Groups, Stage.

Select the “X” next to each filter to remove individually or select “Clear” to remove all filters.

35


Figure 22. Dashboard Filters

6.2.1 Description of Dashboard Filter

Type: Filter search results by content type (Response Sets, Questions, Sections, or Surveys).

Stage: Filter search results by content maturity stage (Draft, Comment Only, Trial Use, Published, Retired, Duplicate).

Owner: Filter search results by the content they have authored.

Groups: Filter search results based on content that belongs to a group of which the user is a member. If the user is logged in and belongs to an authoring group, on the dashboard the user will see a “Filter by Group” drop-down menu as shown in Figure 23.

To view the description and list of members for the group selected, click the “expand” icon next to “Filtering by content in group.”

Figure 23. Filtering Search Results Owned by a Specific Group

36


ADVANCED SEARCH FEATURES

The advanced search features allow the user to further refine and filter how search results are displayed on the dashboard as shown in Figure 24. Multiple advanced search filters may be used at the same time.

6.3.1 How to Use the Advanced Search Filters:

Select “Advanced” from underneath the search bar. Select one or more desired filters from the Advanced Filters Dialog Window. Each

advanced search filter is described in more detail below.

Click “Close” to dismiss the window and view an updated list of results on the dashboard. Filter selections will appear in the search results list.

Select “Clear Adv. Filters” to remove any of the advanced filters applied and view search results across all Programs and Systems.

37


Figure 24. Using Advanced Search Filters

38


6.3.2 Description of Advanced Search Filters

Filtering by Program, Surveillance System, or Both

The Advanced Search feature allows users to find content associated with a specific program, surveillance system, or combination of the two.

To filter by program, system, or both:

Select the desired programs and systems by clicking on them. Select multiple items within the list by holding down the “Shift,” “Control/CTRL,” or “Command/CMD” keys before clicking. Use the search fields to refine the displayed list of programs and systems.

Sorting Content

The user can sort search results by priority. By default, the most relevant search results (see Section 0) are displayed at the top. Items with the same relevance are secondarily sorted by the number of unique systems that are using the item on published Surveys.

To change how search results are sorted:

Select “System Usage” or “Program Usage” from Sort By drop-down menu.

Content Changed Since Filter

This filter allows the user to select a date to see only content edited, revised, or created recently (from the date selected forward).

To view only content that has been changed since a particular date:

Either select a date from the calendar or type in a date in MM/DD/YYYY format.

Most Recent Version Filter

By default, all versions of content that best match the keyword or phrase that the user typed into the search input field are returned in the search results. If the most relevant content has many versions, the top search results displayed may only be different versions of the same Response Set, Question, Section, or Survey, and other relevant matches in SDP-V may not be readily visible. The “most recent versions only” filter limits search results to the most recently published version of other users’ content and to the user’s own most recent version of private content.

To filter by most recent version:

Check the box next to “Most Recent Versions Only.”

TIP: Consider using this filter when creating or revising data collection instruments, because it is likely that the user will want to use the most recent version of vocabulary (as opposed to when a user is adding existing content to the SDP-V repository). This feature is especially valuable when searching for PHIN VADS value sets, because many versions of PHIN VADS value sets exist in SDP-V.

39


CDC Preferred Content Filter

This filter allows the user to select content that has been designated as CDC Preferred. Content will only be marked as CDC preferred by an SDP-V administrator after a recommendation to do so has been put forth by a CDC Harmonization Working Group or other authoritative body.

To filter by content that has been marked as CDC Preferred:

Check the box next to “CDC Preferred Content Only.”

Include Retired Content Filter

VOCABULARY SERVICE (SDP-V) RELEASE 1.22 SURVEILLANCE … · Vocabulary Service (SDP-V) on how to...

Documents

Transcript of VOCABULARY SERVICE (SDP-V) RELEASE 1.22 SURVEILLANCE … · Vocabulary Service (SDP-V) on how to...