Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand

JSON can be set for all CPs at the system level. When OpenSpecimen is installed, there is already a default system-level JSON is already set in the Settings. This contains the list view and aliquot/derivative creation screen configurations. Refer to the steps to edit system JSON:

  1. Navigate to 'Settings'.

  2. Under 'Biospecimen', set the 'System Workflows' property with the new JSON.

  3. Refresh the browser to take effect of the settings.

...

Expand

Section Name

Exclusive to System JSON?

Description

CP List View

Yes

Configures the collection protocol list view and filters.

Participant List View

No

Configures the participant list view and filters of the CP.

Specimen List View

No

Configures the specimen list view and filters of the CP.

Common Specimen List View

Yes

Configures the specimen list view across the system, e.g., reserved specimen list view, cart specimen list view, etc.

Order Specimen List View

Yes

Configures the specimen list view and filter of order created during the distribution.

For more details, please refer to the System lists → Order specimen list view page section of the wiki page.

Order Specimens Add and Edit

Yes

Configures the add and edit page of order during distribution.

For more details, please refer to the System lists → Order specimen add and edit page section of the wiki page.

Container Specimen List View

Yes

Configures the specimen list view and filter in the container pages.

Reserved Specimen List View

Yes

Configures the specimen list view and filter of the reserved specimen tab in the distribution Protocol.

If this section is not used, the fields configured in the Common Specimen List View are used.

For more details, please refer to the System Lists → Reserved Specimen List Page section of the wiki page.

Specimen Cart Page

Yes

Configures under the Specimens-list-view section of the cart. For more details, please refer to the System lists → Specimen Cart Page section of the wiki page.

Common

No

This section configures:

  1. Unplanned Aliquot and Derivative creation page

  2. The Specimen Description format (for Specimen Table)

  3. Which Workflows are used (from v11)

Bulk Update Dictionary

No

Configures the dropdown list of bulk update of participants and specimens from UI.

Dictionary

No

This defines all the fields that will be used for biospecimen data entry in the CP.

The system JSON doesn’t contain a dictionary section and uses default configuration. You can copy and paste the dictionary section from the Participant-centric CP workflow to configure the system JSON dictionary. This is useful only if the same set of data fields apply to all current and future CPs.

E.g., if you want to remove a default field like SSN for all CPs, you can use the dictionary section at system-level JSON to achieve this.

Refer to the Default JSON section files from the wiki page for the JSON.

Edit Checks (Data Validation)

No

These allow users to add validations to fields (at either system, or the CP levels). These ensure the rules aren’t violated during data entry.

Refer to Defining Data Validation for further details.

Visit Table

No

This configures the Visits table on the Participant Overview Page.

Refer to this wiki page.

Specimen Tree

No

This field configures the Specimen Table and Tree view.

Refer to the following page.

Note: Specimen Tree is not present from v11.

Auto-Allocation

No

This is for container auto-allocations (beyond CP and Specimen Type-based allocations). E.g., Container Allocation based on SRs.

Refer to the following wiki page.

Locked Fields

Yes

Allows users to lock participant fields.

Refer to the wiki page.

Specimen Collection (Nth Step)

No

Allows users to add additional details while collecting specimens.

Please refer to the following page.

Form Data Entry Rules

No

Shows/Hides Forms based on conditions.

Refer to the wiki page.

...

Below are the list of configurations supported in v11 onwards.
Depreciated configuration in v11 here.

Various types of configurations can be performed using JSON. We have listed them according to which pages they affect:

...

Expand

...