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

Participant List

MRN Site

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

Participant List

MRN

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

Participant List

External Subject ID

(Supported version V5.1 and onwards)

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

Participant List

Date formatting("participant-list-view")

(Supported version V5.2 and onwards)

Refer wiki for 'Date Formats'

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

Participant List

Consent Document Title

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

Participant List

Consent Version

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

Participant List

Consent Statement

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

Participant List

Consent Response

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

Participant List

Consent Custom Field

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

Participant List

Consent Date

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

Participant List

Custom Form Fields (Participant level)

Syntax: Participant.extensions.<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

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

Specimen List

Date formatting ("specimen-list-view")

(Supported version V5.2 and onwards)

Refer wiki for 'Date Formats'

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

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"
},

Specimen List

Collection Date and Time

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

Specimen List

Received Date and Time

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

Specimen List

Specimen Laterality

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

Specimen List

Visit Name

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

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"
}

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"
}

...