JSON: Participant Default Fields
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

JSON: Participant Default Fields

Introduction

You can use the below configuration settings to show participant fields for data entry or read-only based on your requirements.

Task Configuration

Field Name

Description

Configuration

Field Name

Description

Configuration

PPID

 

{ "name": "cpr.ppid", "caption": "PPID", "type": "text", "optional": false, "showIf": { "op": "OR", "rules": [ { "field": "cp.ppidFmt", "op": "not_exist" }, { "field": "cp.manualPpidEnabled", "op": "exists" } ] } }

Registration Site

 

{ "name" : "cpr.site", "caption" : "Registration Site", "type" : "dropdown", "optional" : true, "listSource" : { "apiUrl" : "collection-protocols/{{cp.id}}/sites", "displayProp" : "name", "selectProp" : "name", "queryParams" : { } } }

External Subject ID

 

{ "name" : "cpr.externalSubjectId", "caption" : "External Subject ID", "type" : "text", "optional" : true }

Registration Date

 

{ "name": "cpr.registrationDate", "caption": "Registration Date", "type": "date", "optional": false, "defaultValue": "current_date" }

First Name

 

{ "name": "cpr.participant.firstName", "caption": "First Name", "type": "text", "optional": true }

Middle Name

 

{ "name": "cpr.participant.middleName", "caption": "Middle Name", "type": "text", "optional": true }

Last Name

 

{ "name": "cpr.participant.lastName", "caption": "Last Name", "type": "text", "optional": true }

Birth Date

 

{ "name": "cpr.participant.birthDate", "caption": "Birth Date", "type": "date", "dateOnly": true, "optional": true }

Social Security Number

 

{ "name": "cpr.participant.uid", "caption": "Social Security Number", "type": "text", "optional": true }

Master Patient Index

 

{ "name": "cpr.participant.empi", "caption": "Master Patient Index", "type": "text", "optional": true }

Gender

 

{ "name": "cpr.participant.gender", "caption": "Gender", "type": "pvs", "attr": "gender", "optional": true }

Vital Status

 

{ "name": "cpr.participant.vitalStatus", "caption": "Vital Status", "type": "pvs", "attr": "vital-status", "optional": true }

Death Date

 

{ "name": "cpr.participant.deathDate", "caption": "Death Date", "type": "date", "optional": true, "showIf": { "op": "AND", "rules": [ { "field": "cpr.participant.vitalStatus", "op": "==", "value": "'Dead'" } ] }, "showInOverviewIf": "useShowIf" }

Race

This is the code/configuration for the Race field.

Editable Field Configuration:

{ "name": "cpr.participant.races", "caption": "Race", "type": "pvs", "attr": "race", "optional": true, "multiple": true }

Read-Only field configuration:

{ "name" : "cpr.participant.races", "caption" : "Race", "type" : "pv", "attr" : "race", "selectProp" : "value", "optional" : true, "multiple" : true, "disableWhen" : "1 != 0" }

Ethnicity

 

Editable field configuration:

{ "name": "cpr.participant.ethnicities", "caption": "Ethnicity", "type": "pvs", "attr": "ethnicity", "optional": true, "multiple": true }

Read-Only field Configuration:

{ "name" : "cpr.participant.ethnicities", "caption" : "Ethnicity", "type" : "pv", "attr" : "ethnicity", "selectProp" : "value", "optional" : true, "multiple" : true, "disableWhen" : "1 != 0" }

MRN

  • listAll: Displays all the sites for users who have access to CP, irrespective of which site they have access to. If you don't add this property, you will only see the sites to which you have access. 

  • Caption: Add a caption so the field name shows on add/edit/overview pages. Without it, you’ll only see the +Add button.

API URL Examples:

  • "apiUrl": "collection-protocols/{{cp.id}}/sites" – Gets sites for the current CP.

  • "apiUrl": "sites" – Gets all your sites.

Dropdown Settings:

  • apiUrl – Where to get data from.

  • displayProp – What name to show.

  • selectProp – What value to save.

  • queryParams – Extra info to send.

  • dynamic – Changes based on user input.

  • static – Always the same.

  • search – Field used to search.

{ "name": "cpr.participant.pmis", "type": "collection", "caption": "MRN", "fields": [ { "name": "siteName", "caption": "Site", "type": "dropdown", "multiple": false, "optional": true, "listSource": { "apiUrl": "sites", "displayProp": "name", "selectProp": "name", "queryParams": { "dynamic": { "operation": "op" }, "static": { "resource": "ParticipantPhi", "listAll" : true }, "search": "name" } } }, { "name": "mrn", "caption": "MRN", "type": "text", "optional": true } ] }
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com