1 Printing Specimen Labels
2 Print Rule Fields Specific to Specimen
3 Print Tokens
- 3.1 Basic Tokens
- 3.2 Advance Tokens
  - 3.2.1 Examples of eval Tokens
    - 3.2.1.1 Collection Protocol Level Tokens
    - 3.2.1.2 Participant Level Token Examples
    - 3.2.1.3 Visit Level Tokens
    - 3.2.1.4 Specimen Level Token Examples
  - 3.2.2 PV Properties Tokens
    - 3.2.2.1 Syntax
    - 3.2.2.2 Examples of PV Tokens
  - 3.2.3 Examples of Advanced Functions Using eval Tokens
    - 3.2.3.1 Conditional Token
    - 3.2.3.2 Null Safe Operator
    - 3.2.3.3 Pick Last Character
    - 3.2.3.4 Concatenate multiple fields
    - 3.2.3.5 Extract Substring Before Separator
    - 3.2.3.6 Extract Substring After Separator
    - 3.2.3.7 Conditional Print Based on Dynamic Values

Printing Specimen Labels

You can configure specimen print rules to print physical specimen labels. OpenSpecimen provides all the necessary information associated with the specimens. You can define label tokens (basic and advanced) in the print rule. If the label is generated using this print rule, the defined tokens will be part of the output label file.

Click on Create → ‘Specimen’ from the print rules page.

Refer to the Print Rules page and Print Tokens for details, and click on the ‘Create’ button

Print Rule Fields Specific to Specimen

Field	Description	Example Values

Field	Description	Example Values
Collection Protocol	Short title of collection protocol(CP). The default value is *, meaning any CP.	Lung Cancer
Visit Site	The collection site of visit. The default value is *, meaning any visit site.	Arkansas Hospital
Lineage	All, Primary, Derived, and Aliquot
Specimen Types	Can select multiple values from the list of types and/or class The default value is *, meaning any specimen type.	Example 1: All Fluid Example 2: Frozen Tissue

Print Tokens

You can use the below tokens to include their corresponding value in printed labels.

Basic Tokens

These tokens are shipped with the default OpenSpecimen and are most commonly used. User can select multiple tokens as per requirements

Sr No	Level	Token Name	Description	Token	Example values

Sr No	Level	Token Name	Description	Token	Example values
1	Collection Protocol	Collection Protocol	CP Short Title	specimen_cp_short	Lung Cancer
2	Participant	Participant Protocol Identifier	PPID-Unique protocol-specific participant ID	specimen_ppid	ETP-9933
3	Participant	Master patient index	Participant unique ID	specimen_mpi	RTB18388
4	Visit	Visit Name	Visit name	visit_name	ETP-9933-S-01
5	Visit	Visit Date	The format of the date is as per locale in use.	visit_date	In US locale, 03-15-2016 Default: 15-03-2016
6	Visit	Specimen Requirement Code	Specimen requirement code, which is set in the CP.	specimen_requirement_code	EDTA, SST, GTT, P1
7	Specimen	Anatomic Site	Specimen anatomic site	specimen_anatomic_site	Abdomen, NOS
8	Specimen	Specimen Class	Specimen class value	specimen_class	Fluid, Molecular, Tissue, Cell
9	Specimen	Specimen Type	Type of specimen	specimen_type	Whole Blood, Serum, Cryopreserved Cells
10	Specimen	Created On	The date the specimen was created. The format of the date is as per locale in use.	specimen_created_on	In US locale, 03-15-2016 Default: 15-03-2016
11	Specimen	Primary Specimen	Primary specimen label at any level of child specimen under it. Useful for printing derivative or aliquot labels.	specimen_primary_label	Consider below lineage of specimens: Primary: ETP-9933-WB1 Derivative: ETP-9933-P1 Aliquot: ETP-9933-P1.1, the token outputs ETP-9933-WB1 when the aliquot is printed
12	Specimen	Label	Specimen label	specimen_label	ETP-9933-S-01-P1
13	Specimen	Barcode	Specimen barcode	specimen_barcode	127182718
14	Specimen	Lineage	Specimen lineage	specimen_lineage	New, Aliquot, Derivative
15	Specimen	Location	Specimen storage location. The format is the Container Name (Row x Column).	specimen_location	Rosy0105 (3 x 4) Rosy0105 is a container name. 3 is the row, and 4 is the column
16	Specimen	Pathological Status	Specimen pathological status.	specimen_pathology	Malignant, Metastatic
17	Specimen	Quantity	Specimen initial quantity	specimen_quantity	2.5, 7000000
18	Specimen	Concentration	Specimen concentration	specimen_concentration	10
19	Specimen	Specimen Collection Container	Collection container of specimen	specimen_collection_container	ACD Vacutainer

Note: When you select one or more standard tokens and then switch to advanced mode, the system will automatically convert default tokens to match the format, and thus, it might look a bit different than what appears in the above table.

Advance Tokens

In addition to basic tokens, you may sometimes need to include additional data from the specimen, visit, or participant records linked to the specimen. These are often required for printing specific information on physical labels.

To support this, OpenSpecimen provides two modes for selecting tokens:

Eval tokens
PV Props

Examples of eval Tokens

Collection Protocol Level Tokens

Sr No.	Field	Example	Description

Sr No.	Field	Example	Description
1	IRB ID	eval("IRB ID",#specimen.collectionProtocol.irbIdentifier)	Evaluates the collection protocol IRB ID
2	CP Code	eval("Code",#specimen.collectionProtocol.code)	Evaluates the collection protocol code
3	CP Principal Investigator's first name	eval("PI First Name",#specimen.collectionProtocol.principalInvestigator.firstName)	Gives the first name of the Principal Investigator of the CP
4	CP Principal Investigator's last name	eval("PI Last Name",#specimen.collectionProtocol.principalInvestigator.lastName)	Gives the Last name of the Principal Investigator of the CP
5	CP custom field	custom_field("Field Name",cp,field_name)	Prints CP custom fields

Participant Level Token Examples

Sr No.	Field	Example	Description

Sr No.	Field	Example	Description
1	External Subject ID	eval("External Subject Id", #specimen.registration.externalSubjectId)	Evaluates participant’s External Subject Id.
2	First Name	eval("First_Name",#specimen.registration.participant.firstName)	Evaluates participant’s First Name.
3	Last Name	eval("Last_Name",#specimen.registration.participant.lastName)	Evaluates participant’s Last Name.
4	Birth Date	eval("DOB",#specimen.registration.participant.birthDate)	Evaluates participant’s Date of Birth.
5	Participant custom field	eval("Participant_Code",#specimen.registration.getExtension()?.getAttrValues()?.get("height")) custom_field("Height",cpr,height)	Evaluates participant custom field height.
6	Participant Initials First letter of First, middle, and last name	eval("FN",#specimen.registration.participant.firstName?.trim()?.length() > 0 ? #specimen.registration.participant.firstName.charAt(0) : ""),eval("MN",#specimen.registration.participant.middleName?.trim()?.length() > 0 ? #specimen.registration.participant.middleName.charAt(0) : ""),eval("LN",#specimen.registration.participant.lastName?.trim()?.length() > 0 ? #specimen.registration.participant.lastName.charAt(0) : "")	Gives the first character from the first name, middle name, and last name in the output.
7	Identifier	eval("Identifier",#specimen.registration.id)	Evaluate the participant identifier

Visit Level Tokens

Sr No.	Field	Example	Description

Sr No.	Field	Example	Description
1	Visit Name	eval("Vist name",#specimen.visit.name)	Evaluates the visit name
2	Visit Date	eval("Vist date",#specimen.visit.visitDate)	Evaluates the visit date
3	Visit custom field	eval("custom",#specimen.visit.getExtension()?.getAttrValues()?.get("additional_diagnosis")) custom_field("Additional_Diagnosis",visit,additional_diagnosis)	Prints value for visit custom field additional_diagnosis.
4	Event Code	eval("Event_Code",#specimen.visit.cpEvent?.code)	Evaluates the event code of the CP corresponding to the specimen’s visit.
5	Event Label	eval("Event_Label",#specimen.visit.cpEvent?.eventLabel)	Evaluates the collection protocol event label corresponding to the specimen’s visit. E.g., ‘Baseline,’ 'Follow-up'
6	Surgical Pathology Number	#specimen.visit.surgicalPathologyNumber	Prints Surgical Pathology number documented at Visit level

Specimen Level Token Examples

Sr No	Field	Example	Description

Sr No	Field	Example	Description
1	Label	eval(“Label”, #specimen.label)	Evaluates the specimen label
2	Identifier	eval(“Identifier”, #specimen.id)	Evaluates the specimen identifier
3	Created On	eval("Created On", #formatDate(#specimen.createdOn, "MMM, yyyy"))	Expression to extract month and year from the created on the field in the specified format
4	Container name and position	eval("Storage",#specimen.position)	Evaluates container name with position in linear or two dimensions(row & column) as per box settings
5	Anatomic Site	eval("site",#specimen.tissueSite.value)	Evaluates the anatomic site
6	Specimen type abbreviation	eval("type",#specimen.specimenType.props['abbreviation'])	Evaluates the specimen type abbreviation
7	Specimen custom field	eval("Ext.Lab.Num",#specimen.getExtension()?.getAttrValues()?.get("ST21")) From v10.2 onwards custom_field("Additive",specimen,additive)	Evaluates visit custom field ST21 From v10.2 onwards Prints value for specimen custom field additive.
8	SR name	eval("SR Name",#specimen.specimenRequirement?.name)	Evaluates the specimen-requirement name.
9	Available Quantity	eval("Available_Qty",#specimen.availableQuantity)	Evaluates the available quantity of the specimen
10	Quantity Unit	eval("type",#specimen.specimenClass.props['quantity_unit'])	Evaluates the quantity unit based on the specimen class.
11	Concentration Unit	eval("Conc unit",#specimen.specimenClass.props['concentration_unit'])	Evaluates the concentration unit based on the specimen class.
12	Laterality	eval("side",#specimen.tissueSide.value)	Evaluates the laterality
13	Received Date	eval("RD",#specimen.receivedEvent.time)	Evaluates the received date
14

Specimen Print Rules