Introduction

Based on the centres or collection protocol need, interest on what to see as participant header might be different. For example some collection protocols needs participant's PPID, first name, and last name as the header, some wants to see MPI. Therefore it is important that participant header can be configured as per protocol or centres needs.

This configuration can be done at two levels.

1. System wide - applies to all protocols
2. Protocol level - overrides the system setting for that protocol

OpenSpecimen is shipped with default header template PPID (FirstName LastName) 

How to configure?

Using CP workflows configuration via REST API, we can provide the HTML template of the header. According to configured HTML template UI will show the participant header.

Below is the JSON format which we can add to workflow JSON and set it at CP or System level.

{
  "name" : "common",
  "data" : {
    "participantHeaderTmpl" : <participant_header_html_template>
  }
} 

Example: Show PPID (LastName FirstName). Show first and last name only if user has PHI access.

{
  "name" : "common",
  "data" : {
    "participantHeaderTmpl" : "<span translate=\"{{cpr.ppid}}\"></span><span ng-if=\"userCtx.hasPhiAccess && (cpr.participant.firstName || cpr.participant.lastName)\"> ( {{cpr.participant.LastName}} {{cpr.participant.firstName}} )</span>"
  }
}

To configure above JSON please refer 'How to configure workflows?'

Below are some examples of header template

1. PPID (MRN) - Show PPID and MRN of site 'New York' if exist. MRN should be display only if user has PHI access.

   Code Block
   language xml
   <span>{{cpr.ppid}}</span> <span ng-if="userCtx.hasPhiAccess" ng-repeat="pmi in cpr.participant.pmis"> <span ng-if="pmi.siteName=='Pune'"> ({{pmi.mrn}}) </span> </span>

   
   

2. PPI (MPI) - Show PPID and master patient index if exist. Master patient index should be display only if user has PHI access.

   Code Block
   language xml
   <span>{{cpr.ppid}}</span> <span ng-if="userCtx.hasPhiAccess && cpr.participant.empi"> <span> ({{cpr.participant.empi}}) </span> </span>