Page Comparison

...

Attribute types and examples

Attribute Type

Description

Example JSON

DropDown

Only male participant registrations are allowed
If Race is one (White or Asian), then Ethnicity should be 'American.'

Code Block

language	json

{
           "records" : [ "cpr" ],
           "rules" : [
             {
               "expr" : "#cpr.participant.gender != null && !#containsAny(#cpr.participant.gender, {'Female', 'Unknown', 'Undifferentiated'})",
               "description" : "Only Male patient should be register"
             }
           ]
         },
         
         {
           "records" : [ "cpr" ],
           "rules" : [
             {
               "when" : "#containsAny(#cpr.participant.races, {'White', 'Asian'})",
               "expr" : "#containsAny(#cpr.participant.ethnicities, {'American'})",
               "description" : "For White/Asian races, Ethnicity should be American"
             }
           ]
         },

Dropdown and Muliselect

If Registration Site='MCRI Repository', then Race values is one of 'White' or 'Asian'
If the patient is ‘Alive’ then Ethnicity should be ‘African’ or 'American'

Code Block

language	json

{
           "records" : [ "cpr" ],
           "rules" : [
             {
               "when" : "#cpr.site == 'MCRI Repository'",
               "expr" : "#containsAny(#cpr.participant.races, {'White', 'Asian'})",
               "description" : "Race should be White/Asin for 'MCRI Repository' site patient"
             }
           ]
         },
         
         
         {
           "records" : [ "cpr" ],
           "rules" : [
             {
               "when" : "#containsAny(#cpr.participant.vitalStatus, {'Alive'})",
               "expr" : "#containsAny(#cpr.participant.ethnicities, {'American', 'African'})",
               "description" : "For alive patient, the enthicity should be American/African"
             }
           ]
         }

Calculated Field (Age)

Participant age at the time of registration should be more than 18 years

Code Block

language	json

{
           "records" : [ "cpr" ],
           "rules" : [ {
             "expr" : "#yearsBetween(#cpr.participant.birthDate, #cpr.registrationDate) >= 18",
             "description" : "Participant should be older than 18 years"
           } ]
         }

DropDown Custom Field

If the patient is ‘Dead’, enter the values for the 'Diagnosed With' field from the dropdown.

Code Block

{
  "records" : [ "cpr" ],
  "rules" : [
    {
      "when" : "#cpr.participant.vitalStatus == 'Dead'",
      "expr" : "#cpr.participant.extensionDetail?.getAttrsMap()?.get('DD3') != null ",
      "description" : "Specify the value for Diagnosed With"
    }
  ]
}

DropDown Multiselect (Custom Field)

If the patient is 'Alive', enter the values for the 'City lived In field from the dropdown.

Code Block

{
         "records" : [ "cpr" ],
         "rules" : [
           {
             "when" : "#cpr.participant.vitalStatus == 'Alive'",
             "expr" : "#cpr.participant.extensionDetail?.getAttrsMap()?.get('MLB4') != null ",
             "description" : "Specify the cities where patient is lived"
           }
         ]
       }

Fancy Control-User

If the user (Surgeon) is 'Krishna W' then the user needs to provide the death cause value (Custom Field) for the patient.

Code Block

{
         "records" : [ "cpr" ],
         "rules" : [
           {
             "when" : "#cpr.participant.extensionDetail?.getAttrsMap()?.get('FC5') == 'Krishna W' ",
             "expr" : "#cpr.participant.extensionDetail?.getAttrsMap()?.get('ST2') != null ",
             "description" : "Specify the death cause if the surgeon is Krishna W"
           }
         ]
       },

Participant page examples

Attribute Type

Description

Example JSON

Text

Patient first name, last name should not be null.

Code Block
{ "records" : [ "cpr" ], "rules" : [ { "expr" : "#cpr.participant.firstName != null && #cpr.participant.lastName != null", "description" : "First name or last name should not be null" } ] },

Text

Allow only capital letters in the field first name

Code Block
{ "records" : [ "cpr" ], "rules" : [ { "expr" : "#cpr.participant.firstName.matches(\"^[A-Z]+$\")", "description" : "Only capital letters allowed for Initials" } ] }

Text Custom Field

If the patient is ‘Dead’ then, specify the value ‘Cause of death.’

Code Block

{
         "records" : [ "cpr" ],
         "rules" : [
           {
             "when" : "#cpr.participant.vitalStatus == 'Dead'",
             "expr" : "#cpr.participant.extensionDetail?.getAttrsMap()?.get('ST2') != null ",
             "description" : "Specify Death Cause"
           }
         ]
       }

Custom Form Field

In the ‘Smoking History Form’ attached at the ‘Participant Forms’ level, if the value of ‘Have you ever smoked’ is ‘Yes’, the error ‘Smokers not allowed!’ should be thrown.

Code Block

{
        "records": ["cpr"],
        "forms": {
          "cpr": [ "smokingHistoryForm" ]
        },
        "rules": [
          {
            "when": "#cprForms != null && #cprForms['smokingHistoryForm'] != null",
            "expr": "#cprForms['smokingHistoryForm']['haveYouEverSmoked'] != 'Yes'",
            "description": "SH:Smokers not allowed!"
          }
         ]
       }

Custom Form Field

‘Male’ participants with the value of ‘Have you ever smoked?’ as ‘Yes’ are not allowed. Error ‘Male smokers not allowed!’ should be thrown.

Code Block

{
          "records": ["cpr"],
          "forms": {
            "cpr": [ "smokingHistoryForm" ]
          },
          "rules": [
            {
              "when": "#cprForms != null && #cprForms['smokingHistoryForm'] != null",
              "expr": "#cpr.participant.gender != 'Male' || #cprForms['smokingHistoryForm']['haveYouEverSmoked'] != 'Yes'",
              "description": "SH:Male Smokers Not allowed!"
            }
           ]
         }

Custom form Date Field

‘Date of participant signed' is a date type custom field. The date is valid if

Valid Date = (Date signed ≤ Today’s Date) otherwise invalid

Code Block

language	json

{
      "records" : [ "cpr" ],
      "rules" : [ {
        "expr" : "#cmp(#cpr.participant.extensionDetail?.getAttrValue('date_participant_signed'), #currentTime()) <= 0",
        "description" : "Participant date signed should be lesser than or equal to current date"
      } ]
    }

Visit page examples

Attribute Type

Description

Example JSON

Dropdown

Clinical diagnosis should be one of 'Cholera', 'Liver cell carcinoma'

Code Block

{
      "records" : [ "visit"],
      "rules" : [
        {
          "when" : "#visit.status == 'Complete'",
          "expr" : "#containsAny(#visit.clinicalDiagnoses, {'Cholera', 'Liver cell carcinoma'})",
          "description" : "Clinical diagnosis should be Cholera/Cholepe"
        }
      ]
    },

Dropdown custom field

If the clinical diagnosis is one of 'Cholera', 'Liver cell carcinoma', then the Diagnosis subtype ID 'Negative'

Code Block

{
      "records" : [ "visit"],
      "rules" : [
        {
          "when" : "#containsAny(#visit.clinicalDiagnoses, {'Cholera', 'Liver cell carcinoma'})",
          "expr" : "#visit.extensionDetail?.getAttrsMap()?.get('DD2') == 'Negative' ",
          "description" : "Clinical Subtype should be Negative"
        }
      ]
    },

Date

Participant/Visit fields:

"Visit date should be the same or later than the registration date!"

Code Block

{
  "records" : [ "cpr", "visit" ],
  "rules" : [
    {
      "expr" : "#cpr.registrationDate != null && #visit.visitDate != null && !#cpr.registrationDate.after(#visit.visitDate)",
      "description" : "Visit date should be same or later than the registration date!"
      }
      ]
    }

Dropdown (Core fields)

If ‘Clinical Diagnoses’ is one of List a then acceptable ‘Anatomic Site’ values will be among List b.
List a: '10 weeks gestation of pregnancy, '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy', '13 weeks gestation of pregnancy, '14 weeks gestation of pregnancy
List b: Extrahepatic bile duct Intrahepatic bile duct Liver

Code Block

{
      "records": ["visit"],
"rules" : [
        {
          "when" : "#specimen.status == 'Collected' && #visit.eventLabel == 'Baseline' && #containsAny(#visit.clinicalDiagnoses, {'10 weeks gestation of pregnancy', '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy', '13 weeks gestation of pregnancy', '14 weeks gestation of pregnancy'})",
          "expr" : "#containsAny(#specimen.anatomicSite, {'Extrahepatic bile duct', 'Intrahepatic bile duct', 'Liver'})",
          "description" : "CORE AS: Check the combo of CD AND AS"
        },
]
}

Dropdown (Custom Form fields)

If the ‘Tumor Site/Anatomic site’ value from the custom form is ‘Extrahepatic bile duct', 'Intrahepatic bile duct', 'Liver', then the allowed values for the 'Tumor Morphology Diagnosis’ field from the custom form will be '10 weeks gestation of pregnancy', '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy, '13 weeks gestation of pregnancy, '14 weeks gestation of pregnancy'

Code Block

{
      "records" : [ "visit" ],
      "forms" : {
        "visit" : [ "newPathologyForm" ]
      },
      "rules" : [ {
        "when" : "#visitForms != null && #visitForms['newPathologyForm'] != null && {'Extrahepatic bile duct', 'Intrahepatic bile duct', 'Liver'}.contains(#visitForms['newPathologyForm']['tumourSiteAnatomicSite'])",
        "expr" : "{'10 weeks gestation of pregnancy', '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy', '13 weeks gestation of pregnancy', '14 weeks gestation of pregnancy'}.contains(#visitForms['newPathologyForm']['tumourMorphologyDiagnosis'])",
        "description" : "CF VISIT: Check the combination of diagnoses and anatomic sites"
      } ]
    }

Dropdown (Core and Custom Form)

If the 'Primary Site' values (Custom Form) are 'Extrahepatic bile duct', 'Intrahepatic bile duct', 'Liver', the allowed value for Clinical Diagnosis (Core) should be in {'10 weeks gestation of pregnancy', '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy', '13 weeks gestation of pregnancy', '14 weeks gestation of pregnancy'}

Code Block

{
      "records" : [ "visit" ],
      "forms" : {
        "visit" : [ "newPathologyForm" ]
      },
      "rules" : [ {
        "when" : "#visitForms != null && #visitForms['newPathologyForm'] != null && {'Extrahepatic bile duct', 'Intrahepatic bile duct', 'Liver'}.contains(#visitForms['newPathologyForm']['tumourSiteAnatomicSite'])",
        "expr" : "#containsAny(#visit.clinicalDiagnoses, {'10 weeks gestation of pregnancy', '11 weeks gestation of pregnancy', '12 weeks gestation of pregnancy', '13 weeks gestation of pregnancy', '14 weeks gestation of pregnancy'})",
        "description" : "Check the combination of Form Anatomic Site and Core Clinical Diagnoses"
      } ]
    }

Dropdown (Core and Custom Form)

If the diagnosis field from the visit level form contains values from the below List, then the allowed value for Clinical Diagnosis (Core) should be 'Non-malignant'.

List:

‘8006/2 Observation for suspected malignant neoplasm’, '8009/1 Non-malignant diagnosis, no history of cancer (Other Medical Care)'.

Why is RegEx used in the edit check? Providing these long multi-choice values in the edit check is not flexible, so RegEx checks for the statement and matches the values.

Code Block

{
        "when" : "#visit.visitDate != null && #visit.status == 'Complete' && #visit.clinicalStatus != null && #visitForms != null && #visitForms['demoPathologyForm'] != null && #visitForms['demoPathologyForm']['diagnosis3'] != null && #visitForms['demoPathologyForm']['diagnosis3'] matches '^\\d+/[0-2].*'",
        "expr" : "#visit.clinicalStatus == 'Non-malignant'",
        "description" : "Check the clinical status value based on the diagnosis"
      },

Primary specimen page examples

Attribute Type

Description

Example JSON

Date

Registration Date vs. Collection Date

The specimen collection date should be the same or later than the registration date.

Code Block

{
          "when" : "#specimen.status == 'Collected'",
          "expr" : "!#cpr.registrationDate.after(#specimen.collectionEvent.time)",
          "description" : "The specimen #specimen.label (#specimen.type) collection date should be same or later than the registration date!"
}

Dropdown custom

The anatomic site should be Brain NOS OR Abdomen NOS for tissue samples

Code Block

{
          "when" : "#specimen.status == 'Collected' && #specimen.specimenClass == 'Tissue'",
          "expr" : "#specimen.anatomicSite == 'Brain, NOS' || #specimen.anatomicSite == 'Abdomen, NOS'",
          "description" : "Anatomic site should be Brain NOS or Abdomen NOS for tissue samples"
        }

Dropdown core

If the participant gender is ‘Male’, then the anatomic site cannot include 'Female genital tract, NOS', 'Overlapping lesion of female genital organs', 'Other specified parts of female genital organs', 'Breast, NOS'

Code Block

{
      "records" : [ "specimen", "cpr", "visit" ],
      "rules" : [
        {
          "when" : "#cpr.participant.gender == 'Male' && #specimen.status == 'Collected' && #visit.eventLabel == 'Baseline'",
          "expr" : "!{'Female genital tract, NOS', 'Overlapping lesion of female genital organs', 'Other specified parts of female genital organs', 'Breast, NOS'}.contains(#specimen.anatomicSite)",
          "description" : "CORE GEN AS: Check the Gender ASite COMBO"
        }
     ]
    }

Date field (core)

Specimen data should be the same or later than the Visit date!

(Visit date allows only ‘Date' whereas Specimen collection date allows 'Date and time data entry. In this Edit check, similar date format is provided for both the date fields.)

Code Block

{
      "records" : [ "visit", "specimen" ],
      "rules" : [ {
        "when" : "#visit.visitDate != null &&  #visit.status == 'Complete' && #specimen.collectionEvent.time != null && #specimen.status == 'Collected'",
        "expr" : "#formatDate(#visit.visitDate,'yyyyMMdd') == #formatDate(#specimen.collectionEvent.time,'yyyyMMdd')",
        "description" : "Correct the visit date to the  specimen collection date"
      } ]
    }

Shipment page examples

Attribute Type

Description

Example JSON

Shipment Shipped Date

Shipment Shipped date should be lesser than current date/time

Code Block

{
"records": ["shipment"],
                "rules": [
                  {
                    "when": "#shipment.status != 'Pending'",
                    "expr": "#cmp(#shipment.shippedDate, #currentTime()) <= 0",
                    "description": "1. Shipment date should be lesser than current date/time"
                  }
                ]
 },

Received Date

Shipment received date should be lesser than current date/time

Code Block

{
"records": ["shipment"],
                "rules": [
                  {
                    "when": "#shipment.status == 'Received'",
                    "expr": "#cmp(#shipment.receivedDate, #currentTime()) <= 0",
                    "description": "2. Shipment received date should be lesser than current date/time"
                  }
                ]
},

Shipment Shipped Date Vs. Specimen Collection Date

Shipment Shipped date should be greater than the specimen collection date

Code Block

  {"records": ["shipment", "shipmentSpecimen"],
                "rules": [
                  {
                    "when": "#shipment.status != 'Pending' && #shipment.shippedDate != null",
                    "expr": "#cmp(#shipment.shippedDate, #specimen.collectionEvent.time) >= 0",
                    "description": "3. Shipment date should be greater than the specimen (#specimen.label) collection date"
                  }
                ]
                },

Shipment Received Date Vs. Specimen Collection Date

Shipment received date should be greater than the specimen collection date

Code Block

  {
  "records": ["shipment", "shipmentSpecimen"],
                "rules": [
                       {
                    "when": "#shipment.status != 'Pending' && #shipment.receivedDate != null",
                    "expr": "#cmp(#shipment.receivedDate, #specimen.collectionEvent.time) >= 0",
                    "description": "4. Shipment receive date should be greater than the specimen (#specimen.label) collection date"
                  }
                ]
   },

Shipment shipped Date Vs. Specimen Collection Date

Shipment shipped date should be greater than the specimen collection date, where the collection is date considered as one day earlier than actual.

Passing condition:

Shipped date:07-02-2023 00:00

Collection date:07-02-2023 22:14

Failed condition:

Shipped date:07-02-2023 00:00

Collection date:08-02-2023 02.14

Code Block

   {
                "records": ["shipment", "shipmentSpecimen"],
                "rules": [
                  {
                    "when": "#shipment.status != 'Pending' && #shipment.shippedDate != null",
                    "expr": "(#shipment.shippedDate.getTime() - (#specimen.collectionEvent.time.getTime() - 24 * 60 * 60 * 1000)) >= 0",
                    "description": "Shipment date should be greater than the specimen collection date"
                  }
                ]
  }

Shipment shipped Date Vs. Specimen Collection Date

Shipment shipped date should be greater than the specimen collection date on specimen event page edit.

The regular expression of comparing shipped Vs collection date doesn’t work on Specimen Event page. To ensure the check validate on ‘Editing' the ‘Collection Event date and time’ this expression is used.

Code Block

{
  "records" : [ "specimen" ],
  "forms" : {
    "specimen" : [ "SpecimenShipmentShippedEvent" ]
  },
  "rules" : [ {
    "when" : "#specimenForms != null && #specimenForms['SpecimenShipmentShippedEvent'] != null",
    "expr": "#collFns.forEvery(#specimenForms['SpecimenShipmentShippedEvent$Array'], 'se', \"#se['time'].after(#specimen.collectionEvent.time)\")",
    "description" : "Shipment date should be later than the collection date."
  } ]
}

Shipment shipped Date Vs. Specimen Collection Date

The Shipment shipped date can be lesser than specimen collection date by 24 hours, not more than that.

Passing condition:

Shipped date:06-02-2023 20:00

Collection date:07-02-2023 18:14

Failed condition:

Shipped date:06-02-2023 20:00

Collection date:08-02-2023 22.14

Code Block

{
   "records": ["shipment", "shipmentSpecimen"],
     "rules": [
                {
                   "when": "#shipment.status != 'Pending' && #shipment.shippedDate != null",
                    "expr": "(#shipment.shippedDate.getTime() - #specimen.collectionEvent.time.getTime()) >= -86400000",
                    "description": "Shipment shipped date cannot occur more than 24 hours before the Specimen collection date."
                }
              ]
}

Shipment shipped Date Vs. Specimen Collection Date

This expression only compares both shipped date Vs Collection Date and ignore the time attached to both fields.

Code Block

{
               "records": ["shipment", "shipmentSpecimen"],
               "rules": [
                 {
                   "when": "#shipment.status != 'Pending' && #shipment.shippedDate != null",
                   "expr": "#shipment.shippedDate.getYear() > #specimen.collectionEvent.time.getYear() || (#shipment.shippedDate.getYear() == #specimen.collectionEvent.time.getYear() && #shipment.shippedDate.getMonth() > #specimen.collectionEvent.time.getMonth()) || (#shipment.shippedDate.getYear() == #specimen.collectionEvent.time.getYear() && #shipment.shippedDate.getMonth() == #specimen.collectionEvent.time.getMonth() && #shipment.shippedDate.getDate() >= #specimen.collectionEvent.time.getDate())",
                   "description": "Shipment date should be greater than the specimen collection date"
                 }
               ]
 }

Order page examples

Attribute Type

Description

Example JSON

Distribution date

Order date should be lesser than current date/time

Code Block

{
                "records": ["order"],
                "rules": [
                  {
                    "when": "#order.status != 'PENDING'",
                    "expr": "#cmp(#order.executionDate, #currentTime()) <= 0",
                    "description": "Order date should be lesser than current date/time"
                  }
                ]
              },

Distribution date Vs. Collection Date

Order date should be greater than the specimen collection date

Code Block

{
                "records": ["order", "orderItem"],
                "rules": [
                  {
                    "when": "#order.status == 'EXECUTED' && #order.executionDate != null",
                    "expr": "#cmp(#order.executionDate, #specimen.collectionEvent.time) >= 0",
                    "description": "Order date should be greater than the specimen (#specimen.label) collection date"
                  }
                ]
              }

Field Dictionary

Expand

title	Field Dictionary used to create the expression in edit check

Core Fields Dictionary for Participants, Visits, and Specimens.

Level

Field Name

Field Expression

Participant

PPID

Code Block

language	json

#cpr.ppid

Participant

First Name

Code Block

language	json

#cpr.participant.firstName

Participant

Middle Name

Code Block

language	json

#cpr.participant.middleName

Participant

Last Name

Code Block

language	json

#cpr.participant.lastName

Participant

Registration Date

Code Block

language	json

#cpr.registrationDate

Participant

External Subject ID

Code Block

language	json

#cpr.externalSubjectId

Participant

Registration Site

Code Block

language	json

#cpr.site

Participant

Birth Date

Code Block

language	json

#cpr.participant.birthDate

Participant

Social Security Number

Code Block

language	json

#cpr.participant.uid

Participant

eMPI

Code Block

language	json

#cpr.participant.empi

Participant

Gender

Code Block

language	json

#cpr.participant.gender

Participant

Vital Status

Code Block

language	json

#cpr.participant.vitalStatus

Participant

Death Date

Code Block

language	json

#cpr.participant.deathDate

Participant

Races

Code Block

language	json

#cpr.participant.races

Participant

Ethnicity

Code Block

language	json

#cpr.participant.ethnicities

Participant

MRN

Code Block

language	json

#cpr.participant.pmis

Visit

Name

Code Block

language	json

#cpr.participant.pmis

Visit

Name

Code Block

language	json

#visit.name

Visit

Status

Code Block

language	json

#visit.status

Visit

Missed By

Code Block

language	json

#visit.missedBy

Visit

Missed Reason

Code Block

language	json

#visit.missedReason

Visit

Visit Date

Code Block

language	json

#visit.visitDate

Visit

Visit Site

Code Block

language	json

#visit.site

Visit

Clinical Diagnosis

Code Block

language	json

#visit.clinicalDiagnoses

Visit

Clinical Status

Code Block

language	json

#visit.surgicalPathologyNumber

Visit

SPR

Code Block

language	json

#visit.clinicalStatus

Visit

Visit Comments

Code Block

language	json

#visit.comments

Specimen

Label

Code Block

language	json

#specimen.label

Specimen

Barcode

Code Block

language	json

#specimen.barcode

Specimen

Lineage

Code Block

language	json

#specimen.lineage

Specimen

Collection Status

Code Block

language	json

#specimen.status

Specimen

Type

Code Block

language	json

#specimen.type

Specimen

Anatomic Site

Code Block

language	json

#specimen.anatomicSite

Specimen

Laterality

Code Block

language	json

#specimen.laterality

Specimen

Pathology Status

Code Block

language	json

#specimen.pathology

Specimen

Initial Qty

Code Block

language	json

#specimen.initialQty

Specimen

Available Qty

Code Block

language	json

#specimen.availableQty

Specimen

Concentration

Code Block

language	json

#specimen.concentration

Specimen

Parent Specimen Label

Code Block

language	json

#specimen.parentLabel

Specimen

Biohazard

Code Block

language	json

#specimen.biohazards

Specimen

Location

Code Block

language	json

#specimen.storageLocation

Specimen

Created On

Code Block

language	json

#specimen.createdOn

Specimen

Freezer Thaw Cycle

Code Block

language	json

#specimen.freezeThawCycles

Specimen

Increment Freeze Thaw Cycle

Code Block

language	json

#specimen.incrParentFreezeThaw

Specimen

Comments

Code Block

language	json

#specimen.comments

Specimen

Collection Date

Code Block

language	json

#specimen.collectionEvent.time

Specimen

Collector

Code Block

language	json

#specimen.collectionEvent.user

Specimen

Received Date

Code Block

language	json

#specimen.receivedEvent.time

Specimen

Receiver

Code Block

language	json

#specimen.receivedEvent.user

Specimen

Collection Container

Code Block

language	json

#specimen.collectionEvent.container

Specimen

Collection Procedure

Code Block

language	json

#specimen.collectionEvent.procedure

Specimen

Received Quality

Code Block

language	json

#specimen.receivedEvent.receivedQuality

Specimen

Frozen Time

Code Block

language	json

#specimen.events.SpecimenFrozenEvent.time

Specimen

Frozen Method

Code Block

language	json

#specimen.events.SpecimenFrozenEvent.frozenMethod

Specimen

Frozen Comments

Code Block

language	json

#specimen.events.SpecimenFrozenEvent.comments

Versions Compared

Old Version 54

New Version Current

Key

Attribute types and examples

Participant page examples

Visit page examples

Primary specimen page examples

Shipment page examples

Order page examples

Field Dictionary