© 2024 IQVIA - All Rights Reserved

Reference list of available label merge tags

Owned by Steffan Stringer (Unlicensed)
Last updated: 13-Dec-2024 by Alex Quail
5 min read

This article contains a reference list of label merge tags extracted from a ClinSpark 22.2 release environment.

Not all label merge tags will be available for, or indeed compatible with, earlier versions of ClinSpark. We will try to update the list periodically, although at any moment, it may not contain the full list of current shared label merge tags as they can be modified outside of formal release cycles.

Customers can export the current list of label merge tags from a given environment by following the instructions in this article Label Merge Tags | Which Merge Tags are already available in my environment? .

Also, please note that label merge tags are not automatically synchronized between e.g. a sandbox, a validation environment or a production environment, nor are the exported with .studydesign files from ‘main’ environments to their ‘test’ pair (reference ❗Notes on Study Design Export and Import ).

"Type","Merge Tag","Description" "Device","DeviceBarcode","system generated barcode for device" "Device","DeviceCalibrationDate","Next calibration date for device" "Device","DeviceCategory","device category" "Device","DeviceManufacturer","device manufacturer" "Device","DeviceName","device name" "Device","DeviceSerialNum","device serial number" "Investigational Product Container","IPCAddress","phone / fax number for a given site" "Investigational Product Container","IPCBarcode","system generated barcode for investigational product container" "Investigational Product Container","IPCCohortName","name of the cohort associated with the container" "Investigational Product Container","IPCContents","notes describing the received IMPs" "Investigational Product Container","IPCDate","date when the container entry was added in the system" "Investigational Product Container","IPCDefaultDoseQuantity","number of capsules that need to be administered during dosing" "Investigational Product Container","IPCDispensationNotes","how the IMP should be dispensed to the subjects" "Investigational Product Container","IPCEpochName","name of the epoch associated with the container" "Investigational Product Container","IPCExpirationDate","date when the IMPs are going to expire" "Investigational Product Container","IPCExpirationNotes","instructions describing what do with IMPs when they expire" "Investigational Product Container","IPCFaxNumber","fax number for site where the container is stored" "Investigational Product Container","IPCInvestigatorName","the name of the study investigator" "Investigational Product Container","IPCLotBatch","the lot/batch code of the IMPs" "Investigational Product Container","IPCNotes","notes associated with a container" "Investigational Product Container","IPCPhoneNumber","phone number for the site where the container is stored" "Investigational Product Container","IPCProductName","product name associated with investigational product" "Investigational Product Container","IPCQuantity","number of IMPs in the given container" "Investigational Product Container","IPCQuantityConfDate","date when the IMPs were confirmed in the system" "Investigational Product Container","IPCQuantityConfFirstName","first name of user who confirmed the IMPs" "Investigational Product Container","IPCQuantityConfLastName","last name of user who confirmed the IMPs" "Investigational Product Container","IPCQuantityConfName","full name of user who confirmed the IMPs" "Investigational Product Container","IPCQuantityConfTime24h","time in 24h clock format when the IMPs were confirmed in the system" "Investigational Product Container","IPCQuantityConfTimeAmPm","time in 12h clock format when the IMPs were confirmed in the system" "Investigational Product Container","IPCQuantityConfTitle","the title of user who confirmed the IMPs" "Investigational Product Container","IPCQuantityConfUsername","user name of user who confirmed the IMPs" "Investigational Product Container","IPCQuantityTransferred","the quantity transferred from a certain container" "Investigational Product Container","IPCReceiptDate","the date when the IMP was received in the pharmacy" "Investigational Product Container","IPCReceiptLocation","the name of the location where certain IMPs are kept" "Investigational Product Container","IPCStatus","describes the status associated with a container" "Investigational Product Container","IPCStorageNotes","instructions describing how to store the IMPs" "Investigational Product Container","IPCTime24h","time in 24h format when the container entry was added in the system" "Investigational Product Container","IPCTimeAmPm","time in the 12-hour clock format when the container entry was added in the system" "Item","ItemBarcode","system generated barcode for item (can be transfer code for aliquot)" "Item","ItemCaOrSubjectNum","cohort assignment number, but if not present the first of subject randomization, screening, or lead-in number" "Item","ItemClinLabDest","returns the name of the lab interface if one is configured, or an empty string otherwise" "Item","ItemCohort","The name of the cohort if applicable." "Item","ItemContainer","Name of the specimen container if applicable" "Item","ItemDestination","Lab Interface name if there is a lab panel attached. SampleTransfer Barcode Notes if there is a Sample Transfer." "Item","ItemDetails","item name, if relevant include sample transfer material or specimen container description" "Item","ItemEpoch","The name of the epoch if applicable." "Item","ItemFormName","The name of the Form that this Item belongs to" "Item","ItemLabelFieldOne","the generic field in item called Label Field One. This can be used for any purpose" "Item","ItemLabelFieldTwo","the generic field in item called Label Field Two. This can be used for any purpose" "Item","ItemLoincCode","the Logical Observation Identifiers Names and Codes (LOINC) code" "Item","ItemMaterial","If there is a SampleTransfer, print the material" "Item","ItemMaterialParent","If there is a SampleTransfer, print the material of the topmost parent aliquot" "Item","ItemName","The item name" "Item","ItemPanelSpecimenCategory","The Specimen Category of the Study Lab Panel" "Item","ItemParentBarcode","The sample parent barcode if it exists" "Item","ItemPathOrPanelName","If a sample path is attached to an item, the sample path name prints; if a lab panel is attached to an item, the panel name prints" "Item","ItemPathOrPanelNameOrName","If a sample path is attached to an item, the sample path name prints; if a lab panel is attached to an item, the panel name prints; otherwise the item name" "Item","ItemSampleTransferMaterial","The material associated with the transfer" "Item","ItemScheduledDate","Scheduled date of an item (only prints for timed activities)" "Item","ItemScheduledTime24h","Returns the scheduled time of the item in 24 hour format, like 15:34" "Item","ItemScheduledTimeAmPm","Returns the scheduled time of the item in 12 hour + AM/PM format, like 05:21 PM" "Item","ItemSitePiName","returns the studysite PI name if one is configured; if not, it returns the PI name set at the site level, and is blank otherwise" "Item","ItemSpecimenContainerDesc","the description of the specimen container" "Item","ItemStudyAnswer","The answer for the specified custom study question." "Item","ItemStudyEpochCohort","study name, and if available epoch and cohort details" "Item","ItemStudyEvt","study event" "Item","ItemStudyEvtTpt","study event, timepoint (if available)" "Item","ItemStudyEvtTptMM","study event, timepoint (if available, omitting seconds)" "Item","ItemStudyName","study name" "Item","ItemStudyProtocol","study protocol" "Item","ItemStudySite","study site ID" "Item","ItemSubIds","Prints out all available subject identifiers, like S0001/0123/L67890" "Item","ItemSubLeadin","subject leadin number" "Item","ItemSubNumPref","If Randomization Number exists: Rand#: 123. Else if Lead In Number exists: L-I#: 123. Else if Screening Number exists: Scr#: 123. Else: L-I/Scr/Rand# NA" "Item","ItemSubRnd","subject randomization number" "Item","ItemSubRndOrScrn","If Randomization Number exists: Rand# 123. Else if Screening Number exists: Scr# 123. Else: Scr/Rand# NA" "Item","ItemSubScrn","subject screening number" "Item","ItemTpt","timepoint (if available)" "Item","ItemTransferBarcodeNotes","sample transfer barcode notes" "Item","ItemVolDob","volunteer date of birth" "Item","ItemVolDobYear","volunteer year of birth" "Item","ItemVolGender","volunteer gender" "Item","ItemVolId","volunteer id" "Item","ItemVolInitials","volunteer initials, date of birth (volunteer id)" "Item","ItemVolNameDOB","Volunteer Name, DOB" "Item","ItemVolSummary","volunteer initials, date of birth (volunteer id)" "LIMS","LimsBarcode","system generated barcode for item (can be transfer code for aliquot)" "LIMS","LimsItemDetails","item name, if relevant include sample transfer material or specimen container description" "LIMS","LimsStudyEpochCohort","study name, and if available epoch and cohort details" "LIMS","LimsStudyEvtTpt","study event, timepoint (if available)" "LIMS","LimsSubjectNum","the first of subject randomization, screening, or lead-in number found for the subject" "LIMS","LimsVolSummary","volunteer initials, date of birth (volunteer id)" "Sample Batch Data","SampleBatchBarcode","system generated barcode for sample batch" "Sample Batch Data","SampleBatchPath","sample path name associated with the sample batch" "Sample Batch Data","SampleBatchProtocolName","protocol name associated with the batch step parent study" "Sample Batch Data","SampleBatchStep","sample task name associated with the batch's sample path step" "Sample Batch Data","SampleBatchStudy","study associated with the sample batch" "Sample Container","SampleContBarcode","system generated barcode for container" "Sample Container","SampleContCohortName","returns the cohort where the sample container is currently being used, if available" "Sample Container","SampleContDesc","container description" "Sample Container","SampleContEpoch","returns the name of the epoch where the sample container is currently being used, if available" "Sample Container","SampleContPeriodEpochCohort","container period, epoch, and cohort separated by commas (if configured)" "Sample Container","SampleContProtocolName","protocol name associated with the container's parent study" "Sample Container","SampleContStudy","study name associated with the container" "Sample Container","SampleContStudyAnswer","returns the answer to the specified custom study question for the study associated with the sample container, if available" "Subject","SubjectAliasVsCuff","Item Alias context for the alias with name matching VS_CUFF" "Subject","SubjectBarcode","system generated barcode for subject" "Subject","SubjectCohort","cohort chosen when generating subject barcode" "Subject","SubjectEpoch","epoch chosen when generating subject barcode" "Subject","SubjectGender","returns volunteer gender as either M or F" "Subject","SubjectNumber","screening / lead-in / treatment numbers for subject (if available)" "Subject","SubjectProtocol","The protocol name for the subject's study" "Subject","SubjectSex","returns volunteer sex as either M or F" "Subject","SubjectStudy","study associated with subject" "Subject","SubjectVolDob","volunteer date of birth" "Subject","SubjectVolDobYear","volunteer year of birth" "Subject","SubjectVolFirstname","volunteer first name" "Subject","SubjectVolId","volunteer id" "Subject","SubjectVolImage","volunteer image" "Subject","SubjectVolInitials","volunteer Initials" "Subject","SubjectVolName","volunteer last name, first name" "Subject","SubjectVolSummary","volunteer initials, date of birth (volunteer id)" "User","UserBarcode","system generated barcode for user" "User","UserFirstname","first name associated with relevant user" "User","UserLastname","last name associated with relevant user" "User","UserName","name associated with relevant user" "User","UserTitle","title associated with relevant user" "User","UserUsername","user name associated with relevant user" "Void Container","VoidBarcode","system generated barcode for void container" "Void Container","VoidEmptyWeight","empty weight of void container" "Void Container","VoidStudyName","Name of the study" "Void Container","VoidSubjectRandomizationNumber","Subject Randomization Number" "Void Container","VoidSubjectScreeningNumber","Subject Screening Number" "Void Container","VoidType","voided specimen"

 

Exported and Printed Copies Are Uncontrolled