Merge pull request #541 from CDCgov/update-docs

[SDPV-730] Update In-app docs
CDCgov · Dec 4, 2018 · 93addc1 · 93addc1
2 parents 678bdb4 + 401973b
commit 93addc1
Show file tree

Hide file tree

Showing 7 changed files with 410 additions and 180 deletions.
diff --git a/config/settings.yml b/config/settings.yml
@@ -22,7 +22,7 @@ oid_prefix:
 elasticsearch:
   log: false
 
-app_version: '1.14-alpha'
+app_version: '1.14'
 disable_user_registration: false
 #
 # This URL should use the internal cluster name for the concept-manager service.

diff --git a/public/api/vocab.yaml b/public/api/vocab.yaml
@@ -379,6 +379,13 @@ paths:
       - application/json
 
       parameters:
+        -
+          name: oid
+          in: query
+          description: |
+            Fetches a single value set by its OID. Overrides other params. If no matching value set with given oid will return resource not found. Note, only value sets imported from PHIN VADS can be queried by their OID in SDPV currently.
+          required: false
+          type: integer
         -
           name: limit
           in: query

diff --git a/webpack/containers/CodedSetTableEditContainer.js b/webpack/containers/CodedSetTableEditContainer.js
@@ -159,38 +159,42 @@ class CodedSetTableEditContainer extends Component {
           <Modal.Title componentClass="h1">Code System Mappings Help</Modal.Title>
         </Modal.Header>
         <Modal.Body>
-          <h2 className="no-padding-top">Purpose</h2>
-          <p>The purpose of Code System Mappings is to facilitate content discovery and reuse.</p>
-          <h2>Definitions</h2>
-          <p><strong>Concept Name: </strong>Keywords from a controlled vocabulary. A controlled vocabulary includes external code systems, such as LOINC or SNOMED-CT, or internally developed vocabularies.</p>
-          <p><strong>Concept Identifier: </strong>This may be a text or coded value that comes from a controlled vocabulary. Note that if you have selected a code system mapping that has already been used in SDP-V or is selected from the results from "Search for external coded items", this field will be automatically populated.</p>
-          <p><strong>Code System Identifier: </strong>The Code System used if you are using a coded value (e.g., LOINC, SNOMED-CT, RxNorm). Note that if you have selected a code system mapping that has already been used in SDP-V or is selected from the results from "Search for external coded items", this field will be automatically populated.</p>
-          <h2>Example Code System Mappings Table</h2>
-          <table className="set-table">
-            <caption>Add, search, and create associated code system mappings</caption>
-            <thead>
-              <tr>
-                <th scope="col" className="display-name-column" id="display-name-column-ex">Concept Name</th>
-                <th scope="col" className="code-column" id="code-column-ex">Concept Identifier</th>
-                <th scope="col" className="code-system-column" id="code-system-column-ex">Code System Identifier</th>
-              </tr>
-            </thead>
-            <tbody>
-              <tr>
-                <td headers="display-name-column-ex">Genus Salmonella (organism)</td>
-                <td headers="code-column-ex">27268008</td>
-                <td headers="code-system-column-ex">SNOMED-CT</td>
-              </tr>
-              <tr>
-                <td headers="display-name-column-ex">Genus Campylobacter (organism)</td>
-                <td headers="code-column-ex">35408001</td>
-                <td headers="code-system-column-ex">SNOMED-CT</td>
-              </tr>
-            </tbody>
-          </table><br/>
-          <p><strong>How to Search for Previously Used Code Mappings</strong><br/>To determine if a code mapping has been used before in SDP-V, start typing in the concept name column of the table. A drop-down list of all previously used code mappings that match the text entered in the field will appear. A user can navigate the list and select a code mapping that was previously used. If a code system mapping is selected from the list, the concept identifier and code system identifier fields will be populated with existing values.</p>
-          <p><strong>How to Search for code mappings from an External Code Systems</strong><br/>Rather than requiring you to copy and paste codes from other code systems, SDP-V allows you to search for codes from specific external code systems by clicking on the “Search for external coded items” magnifying glass icon to the right of the code mappings header. This opens the Search Codes dialog box. You may select a particular code system from the drop-down menu, or enter a search term to search across multiple code systems. This code search functionality searches codes from PHIN VADS. You may add coded values from these search results to the code mappings table by clicking the “Add” selection beside each result.</p>
-          <p><strong>How to Create a New Code System Mapping</strong><br/>A new code system mapping may be created by simply typing a new concept name, concept identifier, and code system identifier (if applicable). A new code mapping should only be created if an existing code mapping does not meet a user’s needs.</p>
+        <h2 clasName='no-padding-top'>Purpose</h2>
+        <p>The purpose of the Code System Mappings table is to identify the governed concepts from code systems like LOINC, SNOMED, PHIN VADS, etc that are associated with response sets, questions, sections, or surveys in SDP-V. That is, the Code System Mappings table identifies how content in SDP-V is represented in another code system.<br/>The Code System Mappings table should only include mapping to governed concepts. Non-governed concepts or keywords should not be added to the Code System Mappings table. If you would like to add keywords to your response set, question, section, or survey to facilitate content discovery or organization, please see the “Keyword Tags” help documentation for information on how to use the “Tags” feature.</p>
+        <p><strong>Mutability: </strong>Any changes to entries in the Code System Mappings table are versioned since code system mappings are a property of the vocabulary itself. This allows users to update the Code System Mappings while maintaining legacy mappings in older SDP-V content versions if needed.</p>
+        <p><strong>Discoverability: </strong>Code System Mappings table fields are included in the dashboard search algorithm so other users can find questions, sections, and surveys with specific concept names, concept identifiers or code system identifiers in SDP-V. For instance, a user can enter “27268008” into the dashboard search box to find content in SDP-V associated with that concept identifier. </p>
+
+        <h2>Definitions</h2>
+        <p><strong>Concept Name: </strong>Term from a controlled vocabulary to designate a unit of meaning or idea (e.g., ‘Genus Salmonella (organism)’). A controlled vocabulary includes external code systems, such as LOINC or SNOMED-CT, or internally developed vocabularies such as PHIN VADS.</p>
+        <p><strong>Concept Identifier: </strong>This is text or a code used to uniquely identify a concept in a controlled vocabulary (e.g., 27268008). Note that if you have selected a code system mapping that has already been used in SDP-V or is selected from the results from "Search for external coded items", this field will be automatically populated.</p>
+        <p><strong>Code System Identifier: </strong>This is the unique designator for a code system also referred to as a controlled vocabulary, in which concepts and value sets are defined (e.g. 2.16.840.1.113883.6.96). LOINC, SNOMED-CT, and RxNorm are code systems. Note that if you have mapped a code system to a question or response set that has already been mapped in SDP-V or returned from an external code system search, the code system identifier field will be automatically populated.</p>
+
+        <h2>Example Code System Mappings Table</h2>
+        <table className="set-table table">
+          <caption><strong></strong></caption>
+          <thead>
+            <tr>
+              <th  id="concept-name">Concept Name</th>
+              <th  id="concept-identifier">Concept Identifier</th>
+              <th  id="code-sytem-identifier">Code System Identifier</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td headers="concept-name">Genus Salmonella (organism)</td>
+              <td headers="concept-identifier">27268008</td>
+              <td headers="code-sytem-identifier">2.16.840.1.113883.6.96</td>
+            </tr>
+            <tr>
+              <td headers="concept-name">Genus Campylobacter (organism)</td>
+              <td headers="concept-identifier">35408001</td>
+              <td headers="code-sytem-identifier">2.16.840.1.113883.6.96</td>
+            </tr>
+          </tbody>
+        </table><br/>
+        <p><strong>How to Search for Previously Used Code Mappings</strong><br/>To determine if a code system mapping has been used before in SDP-V, start typing in the concept name column of the table. A drop-down list of all previously used concept names that match the text entered in the field will appear. A user can navigate the list and select a concept name that was previously used. If a concept name is selected from the list, the concept identifier and code system identifier fields will be populated with existing values already entered in SDP-V.</p>
+        <p><strong>How to Search for Code Mappings from an External Code Systems</strong><br/>Rather than requiring you to copy and paste codes from other code systems, SDP-V allows you to search for codes from specific external code systems by clicking on the “Search for external coded items” magnifying glass icon to the right of the code system mappings header. This opens the Search Codes dialog box. You may select a particular code system from the drop-down menu, or enter a search term to search across multiple code systems. This code search functionality searches codes from PHIN VADS. You may add coded values from these search results to the code mappings table by clicking the “Add” selection beside each result.</p>
+        <p><strong>How to Create a New Code System Mapping</strong><br/>A new code system mapping may be created by simply typing a new concept name, concept identifier, and code system identifier. A new code mapping should only be created if an existing code mapping does not meet a user’s needs.</p>
         </Modal.Body>
         <Modal.Footer>
           <Button onClick={() => this.setState({ showCodeMappingModal: false })} bsStyle="primary">Close</Button>