Import Visit Map

2024-03-28

When manually defining or inferring visits from data does not meet your needs, you can import a visit map in XML format to configure multiple visits in a study in one step.

Import Visit Map

  • From the Manage tab, click Manage Visits.
  • Click Import Visit Map.
  • Paste the contents of the visit map XML file into the box.
  • Click Import.

If the visit map being imported will result in overlapping visit ranges, the import will fail.

Visit Map XML Format

The visit map lists which visits make up the study, which sequence numbers are assigned to them, and additional properties as required. The same options are available as when you create a single visit in the UI. The format of the imported visit map XML must match the study serialization format used by study import/export.

For full details, review the visitMap XML source.

Obtain Visit Map via Export

If you want to use the visit map from one study as the basis for another study, you can export the folder containing the original study. In it, you will find a visit_map.xml file. You can paste the contents of this file into the Import Visit Map box of the new study to create the same visits as in the original.

Sample visit_map.xml

The following sample defines 4 visits, including a baseline.

<?xml version="1.0" encoding="UTF-8"?>
<visitMap xmlns="http://labkey.org/study/xml">
<visit label="Baseline" sequenceNum="0.0" protocolDay="0.0" sequenceNumHandling="normal"/>
<visit label="Month 1" sequenceNum="1.0" maxSequenceNum="31.0" protocolDay="16.0" sequenceNumHandling="normal"/>
<visit label="Month 2" sequenceNum="32.0" maxSequenceNum="60.0" protocolDay="46.0" sequenceNumHandling="normal"/>
<visit label="Month 3" sequenceNum="61.0" maxSequenceNum="91.0" protocolDay="76.0" sequenceNumHandling="normal"/>
</visitMap>

Related Topics