NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added statement about carets (^) based on 5/13 email from Denise.

...

  1. Download the model mapping import template. (Start with a fresh template for each import.) 

  2. Populate your file with information about the model mappings that you want to import. The following table provides instructions for each column in the model map import template. Column names with asterisks (*) are required and column names with carets (^) are auto-populated by the system:

    Column NameInstructions
    DO NOT USELeave empty. 
    Batch UserEnter a batch user name in each row. You can provide any text in this column. The system does not validate this column. 
    Batch NameEnter a batch name in each row. The combination of Batch User and Batch Name must be unique.
    Seq IDSpecify a unique sequence ID in each row.
    *Model Map IDSpecify the unique Public ID for the Model Mapping within caDSR.
    *Model Map VersionSpecify the caDSR version of the Model Mapping.
    Rule IDSpecify the identifier for each individual mapping rule to which you intend to import updates. 
    *Characteristic Group NameSpecify the name assigned to the mapping between two models.
    CardinalitySpecify the number of elements in a set.
    *Mapping Type

    Indicate whether the mapping is based on semantics or derived in another way. Examples are:

    • Semantically Equivalent (same CDE)
    • Semantically Similar (same DEC)
    • Has Derivation (transformation rule and its derivation components)
    ^Source CDE Public IDSpecify the public ID of the source CDE.
    ^Source CDE VersionSpecify the version of the source CDE.
    ^Target CDE Public IDSpecify the public ID of the target CDE.
    ^Target CDE VersionSpecify the version of the target CDE.
    Values mapped?Indicate whether the values are mapped: Yes or No. 
    ^Source Element Long NameSpecify the long name of the source element.
    Source Element Physical NameSpecify the exact database name (table, node, class, and so on) of the source element. 
    ^Source Characteristic Long NameSpecify the long name of the source characteristic.
    Source Characteristic Physical NameSpecify the exact database name (table, node, class, and so on) of the source characteristic.
    ^Source Char OrderSpecify the order that you want to use for sorting lists of source characteristics. 
    ^Source VD TypeSpecify the type of value domain for the source: Enumerated, Enumerated by Reference, or Non-enumerated.
    ^Source Ref Term/Data SourceSpecify the reference term data source for the source.
    Source FunctionSpecify the function used for establishing the transformation value for the Source Characteristic.
    Source ValueSpecify a value from the source model.
    ConditionSpecify the condition: IF or TTTT.
    ParenthesisSpecify the open parenthesis character.
    Logical OperatorSpecify the logical operator (such as AND, OR). 
    Left OperandSpecify the left operand.
    ComparatorSpecify the comparator (such as EQUAL TO, NOT EQUAL TO).
    Right OperandSpecify the left operand.
    ^Target Element Long NameSpecify the long name of the target element.
    Target Element Physical NameSpecify the exact database name (table, node, class, and so on) of the target element. 
    ^Target Characteristic Long NameSpecify the long name of the target characteristic.
    Target Characteristic Physical NameSpecify the exact database name (table, node, class, and so on) of the target characteristic.
    ^Target Char OrderSpecify the order that you want to use for sorting lists of target characteristics. 
    ^Target VD TypeSpecify the type of value domain for the target: Enumerated, Enumerated by Reference, or Non-enumerated.
    ^Target Ref Term/Data SourceSpecify the reference term data source for the target. 
    Target FunctionSpecify the function used for establishing the transformation value for the Target Characteristic.
    Target Function ParameterSpecify the parameter used in the function/operator for establishing the transformation value for the Target Characteristic.
    Target ValueSpecify the constant value used in the function/operator for establishing the transformation value for the Target Characteristic.
    Group OrderSpecify the order in which you want the rule to be executed within the Derivation Group.
    Transformation NotesSpecify notes about a manually entered transformation rule. 
    Transformation RuleDescribe a transformation rule that is not based on common semantics. The rule can be described in various formats including plain text, pseudo code, or other programming languages.
    Transformation Rule NotationSpecify a controlled list of values depicting the nature of the transformation rule.
    Validation PlatformSpecify the name of a vendor's software platform that has implemented and validated the transformation rule. Examples are Palantir, Talend, or Pentaho.
    Provenance OrganizationSpecify the name of the organization responsible for reviewing and verifying the mapping between the source and target model characteristics.
    Provenance ContactSpecify the name of the individual responsible for reviewing and verifying the mapping between the source and target model characteristics.
    Provenance Review ReasonSpecify the reason for the provenance activity. For example: "The value set changed."
    Provenance Type Of ReviewSpecify the kind of review that was done. For example: "An HL7 Ballot."
    Provenance Review DateSpecify the date of this source/target characteristics mapping review. 
    Provenance Approval DateSpecify the date the reviewing organization approved this source/target characteristics mapping.

    As you populate your file, keep in mind the following points:

    • You may add additional columns to your file for taking/keeping notes after the last template column, but the column names must be unique.
    • You can use your Delete key to clear the contents of one or more individual cells, but do not delete entire rows or columns. 

  3. Use the Microsoft Excel "Save As" feature to save your copy of the template as CSV. 
  4. Import the file into OneData:
    1. Log in as described in Logging In.
    2. From the Manage menu, select Manage Data. The Manage Data page appears. Select Model Mapping Import or Update. The Model Mapping Import or Update page appears. (For instructions on adding this page to your favorites, refer to Managing Favorites.)
    3. From the Import menu, select Data Object Import
    4. Select the Model Map Import v1 row and click Import (between Add New Mapping and Go To Data Manager).
    5. Under Source Information, in the Import from File row, click Choose File. Navigate to and select your CSV file from your desktop.
    6. Click Import at the bottom of the page. The system displays a message with the status of your import.
  5. To review the model mappings you have imported from your file:
    1. Click Go To Data Manager. The Model Mapping Import or Update page reappears.
    2. Specify search criteria, such as all or part of your Batch Name. The format for the Date Last Modified field is MM/DD/YY (such as 03/05/22). 
    3. Click Apply Filter. A grid appears with one row per model mapping. 

      Expand
      titleView columns in the Model Mapping Import or Update grid
      ColumnDescription
      *Batch UserThe batch user value from the import file. 
      *Batch NameThe batch name value from the import file. 
      *Seq IDThe sequence ID value from the import file. 
      Date Last ModifiedThe date the model was imported or modified. The format is MM/DD/YY (such as 03/05/22) followed by a timestamp. 
      Validation StatusThe status of the validation. 
      *Model Map Generated NameA name generated by the system from the Source Model Name and Version and the Target Model Name and Version.
      *Model Map IDPublic ID for the model mapping. 
      *Model Map VersionThe unique version identifier of the Administered Item.
      Validation MessageA message about the validation.  
      Characteristic Group NameA name assigned to the mapping between two models. 
      Source Element Physical NameThe exact database name of the source element.  
      Source Element Long NameThe long name of the source element. 
      Source Characteristic Physical NameThe exact database name of the source characteristic. 
      Source Characteristic Long NameThe long name of the source characteristic. 
      ConditionA condition (such as ELSE, ENDIF, IF, THEN).
      ParenthesisAn open parenthesis character.
      Logical OperatorA logical operator (such as AND, OR). 
      Left OperandAn operand (such as SOURCE).
      ComparatorA comparator (such as EQUAL TO, NOT EQUAL TO).
      Right OperandAn operand.
      Target Element Physical NameThe exact database name (table, node, class, and so on) of the target element.  
      Target Element Long NameThe long name of the target element. 
      Target Characteristic Physical NameThe exact database name (table, node, class, and so on) of the target characteristic. 
      Target Characteristic Long NameThe long name of the target characteristic.   
      *Mapping Type

      Indicates whether the mapping for this transformation rule is based on semantics or derived in another way. Examples are:

      • Semantically Equivalent (same CDE)
      • Semantically Similar (same DEC)
      • Has Derivation (transformation rule and its derivation components)
      Imported Mapping TypeThe mapping type from the import file. 
      Source FunctionThe function used for establishing the transformation value for the Source Characteristic.
      Source ValueA value from the source model. 
      Imported Source FunctionThe function specified in the import file for establishing the transformation value for the Source Characteristic.  
      Target FunctionThe function (such as CAST, COALESCE, CUSTOM XREF, EQUALS) used for establishing the transformation value for the Target Characteristic.
      Imported Target FunctionThe function specified in the import file for establishing the transformation value for the Target Characteristic. 
      Target Function ParameterThe parameter used in the function/operator for establishing the transformation value for the Target Characteristic. 
      Target ValueThe constant value used in the function/operator for establishing the transformation value for the Target Characteristic. 
      Group OrderThe order in which the rule is executed within the Derivation Group. 
      Transformation NotesMiscellaneous notes about a manually entered transformation rule.  
      Transformation RuleA description of a transformation rule that is not based on common semantics. The rule can be described in various formats including plain text, pseudo code, or other programming languages. 
      *Transformation Rule NotationA controlled list of values depicting the nature of the transformation rule.
      Imported Transformation Rule NotationA controlled list of values from the import file depicting the nature of the transformation rule. 
      Validation PlatformThe name of a vendor's software platform that has implemented and validated the transformation rule. Examples are Palantir, Talend, or Pentaho.
      Imported CardinalityThe number of elements in a set, from the import file.
      Value Mapping Created?Indicates whether the values are mapped: Yes or No. 
      Provenance OrganizationThe name of the organization responsible for reviewing and verifying the mapping between the source and target model characteristics. 
      Imported Provenance OrgThe name from the import file of the provenance organization.
      Provenance ContactThe name of the individual responsible for reviewing and verifying the mapping between the source and target model characteristics. 
      Imported Provenance ContactThe name from the import file of the provenance contact. 
      Provenance Review ReasonThe reason for the provenance activity. For example: "The value set changed." 
      Provenance Type of ReviewThe kind of review that was done: For example: "An HL7 Ballot." 
      Provenance Review DateThe date of this source/target characteristics mapping review.  
      Provenance Approval DateThe date the reviewing organization approved this source/target characteristics mapping. 
      Rule IDAn identifier for each individual mapping rule. Used when importing updates to existing mapping rules. 
      Source VD TypeThe type of value domain for the source: Enumerated or non-enumerated. 
      Target VD TypeThe type of value domain for the target: Enumerated or non-enumerated. 
      *Source Element Physical NameThe exact database name of the source element.
      *Source Characteristic Physical NameThe exact database name of the source characteristic.
      Value Domain TypeThe type of value domain for the source: Enumerated or non-enumerated. 
      *Target Element Physical NameThe exact database name of the target element.
      *Target Characteristic Physical NameThe exact database name of the target characteristic.
      Value Domain TypeThe type of value domain for the target: Enumerated or non-enumerated.
      Imported Rule IDAn identifier from the import file for each individual mapping rule. Used when importing updates to existing mapping rules. 
      Date SortThe date the model was imported or modified. The format is MM/DD/YYYY (such as 05/01/2023) followed by a timestamp.
      Imported Logical OperatorA logical operator (such as AND, OR) from the import file.
      Source Characteristic OrderAn order that can be used for sorting lists of Characteristics 
      Target Characteristic OrderAn order that can be used for sorting lists of Characteristics 
      Imported ConditionA condition (such as ELSE, ENDIF, IF, THEN) from the import file.
      Imported ComparatorA comparator (such as EQUAL TO, NOT EQUAL TO) from the import file.
      Imported ParenthesisAn open parenthesis character from the import file. 


    4. Click the edit icon in the row you want to view. A detail page appears for the selected model mapping.
  6. In each detail page, you have the following options:
    1. To view the next item from your imported file, click the Go to the next page icon (the triangle icon after Rows x of xxx).
    2. To view the list of items again, click Display Values
    3. Make changes in editable fields and click Save. The system confirms the change.  

...