= CiviCRM =

[[Technical deployment tasks for CiviCRM]]

[[Use case description for Genvasc]]

Currently this page is a record of our deployment of CiviCRM - initially as a recruitment process manager for the GENVASC project.

briccsapp04.xuhl-tr.nhs.uk - test system[[BR]]
briccsapp05.xuhl-tr.nhs.uk - live system[[BR]]

=== CiviCRM Object Model ===


=== Contacts ===
Contact entries for LCBRU staff are created automatically from the relevant drupal account. And the drupal account is created automatically at first log-in using LDAP. Smooth.

Non-staff will have contact records created for them separately and manually.

* Address
  * State / Province - is replaced by 'county' during localization to UK
  * County - do not use (this is a different division than UK County

Custom fields likely to be necessary for participants
* GP surgery - relationship to an organisational record
* NHS number
* UHL S number


=== Groups ===
* LCBRU staff (ACL group, to allow for ACL role of 'LCBRU staff' to have edit permissions on contacts etc) - could this be a 'SMART GROUP' based on the drupal account being in the associated drupal role 'LCBRU staff'.

=== Tags ===
How are we going to use 'tags'? For the time being delete all tags.

=== Case type ===
Represents the study.

Needs custom fields to represent the study ID number? Since 4.2.0 custom fields can be attached to a specific case type. This works quite nicely but will need the use of 'hooks' to intercept the data and validate it is unique before entry into the database.

Disable the sample case types. Create a new case type for 'GENVASC'.

Each case type requires an xml configuration file in /civicrm/CRM/Case/xml/configuration/


=== Cases ===
Represents the recruitment of a participant against a specific study.[[BR]]
Might need a revised form template as 'details', 'duration' and 'subject' are not really relevant.[[BR]]


* Medium (represents the recruitment method) - needs additional options (it's the 'encounter medium' option group):
  * GP surgery

* Location
* Details
* Subject
* Case type

* Case roles - recruiter, venepuncturist, case administrator, project manager, lab processor, principal investigator.

* Case status - defined four so far: recruited (opened), declined (closed), withdrawn (closed), excluded (closed).