Page Comparison

...

Expand

title	Click here to view details for the configuration..

The code has three parts - records, forms and rules
1. records - Whenever any of these specified records are modified; the constraint rules should be evaluated/enforced. This refers Refers to the fields at the data entry level at which the fields are present for which the edit check validation is to be applied. The value for records can be cpr, specimen, visit or a combination of these.
2. forms - Optional field. If present, specifies the list of forms whose data is used to enforce the constraints.
3. rules - List of integrity rules that should be satisfied by the records and forms.
A ‘rule’ is made up of three attributes when, expr, and description.
1. when: The attribute 'when' is optional and specifies when the rule is applicable. For example, the rule is applicable only for primary specimens
2. expr: The attribute 'expr' specifies the check constraint that should be satisfied.
3. description: The attribute 'description' describes the constraint in user-friendly language. This is also used in error messages when the rule is broken or not satisfied.
Aliases for rules are - “cpr, visit, primarySpecimen, specimen”, which are self-explanator.
Aliases for accessing the form records are cprForms, visitForms, primarySpecimenForms, specimenForms. These are maps that can be indexed by the form name to access the relevant form data. For example, specimenForms['SpecimenFrozenEvent'] can be used to access the latest frozen event. Similarly, specimenForms['SpecimenFrozenEvent$Array'] can be used to access the list of all the frozen events for the specimen in question.

Example: Visit date should be same or later than the registration date

For more examples, please refer to the wiki page Data Validation Examples

Expand

title	Click here to view details..

Code Block

language	json

{
  "name" : "editChecks",
  "data" : {
    "constraints" : [ 
      {
        "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!"
          } 
        ]
      }
    ]
  }
}

Data Validation Fields

We can set up data validation on these 3 types of fields and their combinations:

Core fields
Custom fields
Custom form fields
Combination of the core fields, custom fields, custom form fields

Expand

title	Field dictionary used to create the expression in data validations

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

Adding Multiple Data Validations

In case there are many edit checks data validations to be performed, here is a tip that could help in avoiding errors:

Check and test the data entry workflow after adding each edit checkvalidation. This will allow you to identify if any edit check validation fails and will be useful in rectifying the failed one. In case If all the edit checks validation are added together, it might will be difficult to identify the edit check validation in case the above error ‘Cannot index into a null value’ occurs.

Versions Compared

Old Version 1

New Version Current

Key

Data Validation Fields

Adding Multiple Data Validations