Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

  1. Configured under the "order-specimens-list-view" section of the JSON

  2. If the user is not configured any "order-specimens-list-view" in the system workflow, then OpenSpecimen uses the default configuration.

  3. Added an option to hide the empty columns by specifying the property "hideEmptyColumns": true,

Expand
titleClick here to view the exmple JSON
Code Block
{
        "name": "order-specimens-list-view",
        "data": {
            "columns": [
                {
                    "expr": "Specimen.specimenOrders.label",
                    "caption": "Distribution Label"
                },
                {
                    "expr": "Specimen.label",
                    "caption": "Label",
                    "metainfo": {
                        "showLink": "true"
                    }
                },
                {
                    "expr": "Specimen.type",
                    "caption": "Type"
                },
                {
                  "expr": "Specimen.pathologicalStatus",
                  "caption": "Pathology Status"
                },
		 		{
                  "expr": "Specimen.creationEvent.createdBy",
                  "caption": "Created By"
                },
                {
                    "expr": "CollectionProtocol.shortTitle",
                    "caption": "Collection Protocol"
                }
            ],
            "hideEmptyColumns": true,
            "criteria": "",
            "orderBy": [
                {
                    "expr": "Specimen.specimenOrders.itemId",
                    "direction": "asc"
                }
            ],
            "filters": [
                {
                    "expr": "Specimen.label",
                    "caption": "Label",
                    "searchType": "contains"
                },
                {
                    "expr": "Specimen.type",
                    "caption": "Type"
                },
                {
                    "expr": "CollectionProtocol.shortTitle",
                    "caption": "Collection Protocol"
                }
            ]
        }
    }

...

Expand

List Page

Field Name

Expression

1.

Participant List

MRN Site

Code Block
languagejson
{
"expr": "Participant.medicalRecord.mrnSiteName",
"caption": "Site"
}

2.

Participant List

MRN

Code Block
languagejson
{
"expr": "Participant.medicalRecord.medicalRecordNumber",
"caption": "MRN"
}

3.

Participant List

External Subject ID

(Supported version V5.1 and onwards)

Code Block
languagejson
{
"expr": "Participant.externalSubjectId",
"caption": "External Subject ID"
}

4.

Participant List

Date formatting("participant-list-view")

(Supported version V5.2 and onwards)

Refer to wiki for 'Date Formats'

Code Block
languagejson
{
  "expr": "Participant.dateOfBirth",
  "caption": "Date Of Birth",
  "expr": "date_format(Participant.dateOfBirth, \"%month2%-%month_day%-%year4%\")"
}

5.

Participant List

Consent Document Title

Code Block
languagejson
{
      "expr" : "Participant.econsents.docTitle",
      "caption" : "eConsent Doc Title"
}

6.

Participant List

Consent Version

Code Block
languagejson
{
      "expr" : "Participant.econsents.docVersion",
      "caption" : "Version"
}

7.

Participant List

Consent Statement

Code Block
languagejson
{
      "expr" : "Participant.econsents.stmtResponses.statement",
      "caption" : "Consent Statement"
}

8.

Participant List

Consent Response

Code Block
languagejson
{
      "expr" : "Participant.econsents.stmtResponses.response",
      "caption" : "Response"
}

9.

Participant List

Consent Custom Field

Code Block
languagejson
{
      "expr" : "Participant.econsent.customFields.additionalRegistration.preferredLanguage",
      "caption" : "Preferred Language"
}

10.

Participant List

Consent Date

Code Block
languagejson
{
  "expr": "Participant.consentSignDate",
  "caption": "Date of Consent",
  "datatype": "date"
}

11.

Participant List

Custom Fields (Participant level)

Syntax: Participant.customFields.<formName>.<attributeName>

<formName>: Replace it with the 'Form Name' of the custom form

<attributeName>: Replace it with the 'Attribute Name' of the custom form field

Note: Ensure that the custom fields are defined in the dictionary section before configuring them in list view columns or filter section.

Code Block
languagejson
{
  "expr": "Participant.customFields.smokingHistoryForm.dateOfSigning",
  "caption": "Signing Date of Smoking History Form",
  "datatype": "date"
}

12.

Participant List

Add Custom field of any type dropdown, text, text field

  1. "Participant.customFields" → Default syntax to call participant custom field 

  2. "patient_details_form"→ Custom form name

  3. "patient_initials"→ Field udn present in a custom form XML

Example:

Patient initials

{
"expr": "Participant.customFields.patient_details_form.patient_initials",
"caption": "Patient Initials"
}

13.

Specimen List

Date formatting ("specimen-list-view")

(Supported version V5.2 and onwards)

Refer to wiki for 'Date Formats'

Code Block
languagejson
{
  "expr": "Specimen.createdOn",
  "caption": "Created On",
  "expr": "date_format(Specimen.createdOn, \"%month3%-%month_day%-%year4%\")"
}

14.

Specimen List

Add Custom field of any type dropdown, text, number, fancy control, etc

  1. "Specimen.customFields" → Default syntax to call specimen custom field 

  2. "wCMCSpecimenFields"→ Custom form name

  3. "diseaseStatus"→ Field udn present in a custom form XML

Eg:1

Disease Status

Code Block
languagejson
{
"expr":"Specimen.customFields.wCMCSpecimenFields.diseaseStatus",
  "caption" : "Disease Status"
}

Eg:2

Technician(User Fancy Control)

Code Block
languagejson
{
 "expr" : "Specimen.customFields.wCMCSpecimenFields.technician",
 "caption" : "Technician"
},

15.

Specimen List

Collection Date and Time

Code Block
languagejson
{
 "expr" : "Specimen.spmnCollRecvDetails.collTime",
  "caption" : "Collection Date"
}

16.

Specimen List

Collection Container

Code Block
languagejson
{
 "expr" : "Specimen.spmnCollRecvDetails.collContainer",
  "caption" : "Collection Container"
}

17.

Specimen List

Collection Procedure

Code Block
languagejson
{
 "expr" : "Specimen.spmnCollRecvDetails.collProcedure",
      "caption" : "Collection Procedure"
}

18.

Specimen List

Received Date and Time

Code Block
languagejson
{
"expr": "Specimen.spmnCollRecvDetails.recvTime",
"caption": "Received on"
}

19.

Specimen List

Specimen Laterality

Code Block
languagejson
{
      "expr" : "Specimen.tissueSide",
      "caption" : "Laterality"
}

20.

Specimen List

Visit Name

Code Block
languagejson
 {
      "expr" : "SpecimenCollectionGroup.name",
      "caption" : "Visit Name"
 }

21.

Specimen List

Clinical Diagnoses

Code Block
languagejson
 {
      "expr" : "SpecimenCollectionGroup.clinicalDiagnoses.value",
      "caption" : "Clinical Diagnoses"
 }

22.

Specimen List

Visit Custom Field

Add visit custom fields to the specimen list view page:

  1. “SpecimenCollectionGroup.customFields”: Default syntax to call visit custom field

  2. “visit_data_extension“: Custom form name

  3. “sequence_number“: Field udn present in a custom form XML

Code Block
languagejson
{
"expr":"SpecimenCollectionGroup.customFields.visit_data_extension.sequence_number",
  "caption" : "Sequence Number"
}

23.

Specimen List

Participant Registration Site

Code Block
languagejson
{
      "expr" : "Participant.site",
      "caption" : "Registration Site"
    }

24.

Specimen List

Participant Registration Date

Code Block
languagejson
{
      "expr" : "Participant.regDate",
      "caption" : "Registration Date"
    }, 

25.

CP List View

Add: Collection Protocol Code in list view page(Supported from v9.0)

Code Block
languagejson
 {
   "expr": "CollectionProtocol.code",
   "caption": "CP Code"
  },

26.

CP List View

Custom Field:

In 'expr', 'cPCustomFields' is a Form Name, 'type' is an attribute name.

Code Block
languagejson
{
  "expr": "CollectionProtocol.customFields.cPCustomField.type",
  "caption": "CP Type"
}

27.

Participant List

Registration Site

Code Block
languagejson
{
      "expr" : "Participant.site",
      "caption" : "Registration Site"
    }

28

Specimen List

Collection Protocol Event Label

Code Block
languagejson
{
      "expr" : "SpecimenCollectionGroup.collectionProtocolEvent.collectionPointLabel",
      "caption" : "Event Label"
    }

29

Participant List

Participant Creation Date and Time

Code Block
languagejson
{
      "expr" : "Participant.creationTime",
      "caption" : "Creation Date"
    },