Data Sharing Manager/Projects: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
{{Help}}
{{Help}}
Projects are defined in Data Sharing Manager as the detailed configuration of a specific data sharing agreement use case. Use Data Sharing Manager to view, manage, or add projects.
'''Projects''' are defined in Data Sharing Manager as the detailed configuration of a specific data sharing agreement use case.  
Use Data Sharing Manager to view, manage, or add projects.<br>
'''Data sets''' define what data is used in a project in Data Sharing Manager. Use Data Sharing Manager to view, manage, or add data sets.<br>
'''Cohorts''' define the criteria that is used to select the patients for projects in Data Sharing Manager. Use Data Sharing Manager to view, manage, or add cohorts.


{{Warning|Publisher’s data will not be shared with a subscriber unless there is an active data sharing agreement and an active project in Data Sharing Manager.}}   
{{Warning|Publisher’s data will not be shared with a subscriber unless there is an active data sharing agreement and an active project in Data Sharing Manager.}}   
Line 6: Line 9:
Use this section to help you to:
Use this section to help you to:


* [[Data Sharing Manager/Projects#view|View Projects]]
[[Data Sharing Manager/Projects#projects|'''Projects''']]
* [[Data Sharing Manager/Projects#view details|View project details]]
* [[Data Sharing Manager/Projects#view projects|View Projects]]
* [[Data Sharing Manager/Projects#edit|Edit a project]]
* [[Data Sharing Manager/Projects#view project details|View project details]]
* [[Data Sharing Manager/Projects#add|Add a new project]]
* [[Data Sharing Manager/Projects#edit project|Edit a project]]
* [[Data Sharing Manager/Projects#add project|Add a new project]]
[[Data Sharing Manager/Projects#data_sets|'''Data sets''']]
* [[Data Sharing Manager/Projects#view data set|View Data sets]]
* [[Data Sharing Manager/Projects#view data set details|View Data set details]]
* [[Data Sharing Manager/Projects#edit data set|Edit a data set]]
* [[Data Sharing Manager/Projects#add data set|Add a new data set]]
[[Data Sharing Manager/Projects#cohorts|'''Cohorts''']]
* [[Data Sharing Manager/Projects#view cohort|View Cohorts]]
* [[Data Sharing Manager/Projects#view cohort details|View cohort details]]
* [[Data Sharing Manager/Projects#edit cohort|Edit a cohort]]
* [[Data Sharing Manager/Projects#add cohort|Add a new cohort]]


{{Note|You must make sure that any required changes to a project, such as removing a publisher or subscriber organisation, or if the project is no longer active, is reflected in Data Sharing Manager. Any changes made in Data Sharing Manager will affect the live service.}}  
{{Note|You must make sure that any required changes to a project, such as removing a publisher or subscriber organisation, or if the project is no longer active, is reflected in Data Sharing Manager. Any changes made in Data Sharing Manager will affect the live service.}}  


<span id="view"></span>
<span id="projects"></span>
== View Projects==
==Projects==
 
<span id="view project"></span>
===View Projects===


#[https://wiki.discoverydataservice.org/Access_Data_Sharing_Manager Access Data Sharing Manager].
#[https://wiki.discoverydataservice.org/Access_Data_Sharing_Manager Access Data Sharing Manager].
Line 20: Line 37:
#:{{Tip|1=Click <i class="fas fa-arrow-up"></i> next to '''Name''' to order the projects and use the page navigations to show more rows per page or to easily access another page.}}
#:{{Tip|1=Click <i class="fas fa-arrow-up"></i> next to '''Name''' to order the projects and use the page navigations to show more rows per page or to easily access another page.}}


<span id="view details"></span>
<span id="view project details"></span>


==View project details==
===View project details===
#[[Data Sharing Manager/Projects#view|View Projects]].
#[[Data Sharing Manager/Projects#view project|View Projects]].
#Click the link of the required project.
#Click the link of the required project.
#If required, click the tab links to display details for one or more of the following:
#If required, click the tab links to display details for one or more of the following:
Line 36: Line 53:
#If required, click the link of the required item to view further details.
#If required, click the link of the required item to view further details.


<span id="edit"></span>
<span id="edit project"></span>


==Edit a project==
===Edit a project===
{{Note| You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.}}
{{Note| You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.}}
{{Warning|Any changes to the project status, project dates, or the publisher and subscriber organisations, directly affect the live project. If you want to remove a publisher from the project, please remove them from the project publisher organisations and contact us at [mailto:datasupport@endeavourhealth.org datasupport@endeavourhealth.org] so that we can revoke the subscriber’s access to the data.}}
{{Warning|Any changes to the project status, project dates, or the publisher and subscriber organisations, directly affect the live project. If you want to remove a publisher from the project, please remove them from the project publisher organisations and contact us at [mailto:support@voror.co.uk support@voror.co.uk] so that we can revoke the subscriber’s access to the data.}}
#[[Data Sharing Manager/Projects#view details|View project details]].
#[[Data Sharing Manager/Projects#view project details|View project details]].
#Click <i class="fas fa-pencil"></i> to edit the selected project.  The '''Project details''' dialog box is displayed.
#Click <i class="fas fa-pencil"></i> to edit the selected project.  The '''Project details''' dialog box is displayed.
#If required, edit one or more of the following:
#If required, edit one or more of the following:
Line 53: Line 70:
#:*Patient consent model
#:*Patient consent model
#:*De-identification level
#:*De-identification level
#:*Project type
#:*Project type (extract, query, API, distribution)
#:*Status
#:*Status
#:*Start date
#:*Start date
#:*End date
#:*End date
#:*Application policy
#:*Application policy
#:*Config name (only displayed if the project type is distribution)
#:*Authorised checkbox
#Click '''Save project'''.
#Click '''Save project'''.
#If required, in one or more of the following, click <i class="fas fa-plus"></i>:
#If required, in one or more of the following:
#:* Sharing agreements
#:* Sharing agreements
#:* Publishers - this is a pre-defined list from the organisations available in the sharing agreement
#:* Publishers - this is a pre-defined list from the organisations available in the sharing agreement
#:* Subscribers
#:* Subscribers - this is a pre-defined list from the organisations available in the sharing agreement
#:* Documents
#:* Documents
#:* Cohort
#:* Cohort - this is a pre-defined list of existing cohorts. To create a new cohort see [[Data Sharing Manager/Projects#cohorts|'''Cohorts''']].
#:* Data sets
#:* Data sets - this is a pre-defined list of existing data sets. To create a new data set see [[Data Sharing Manager/Projects#data_sets|'''Data sets''']].
#*Select one or more of the existing items, and then click '''Add'''.
#Click <i class="fas fa-plus"></i> to add a new item, in the '''Add dialog''' box, select one or more of the available items, and then click '''Add selected'''.
#Select one or more of the existing items, click <i class="fas fa-trash"></i>, and then, in the '''Remove''' dialog box, click '''Remove'''.
#:::{{Tip| Use the parent checkbox to select or deselect all items.}}


<span id="add"></span>
<span id="add project"></span>


==Add a project==
===Add a project===
{{Note| You can only add a new project if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.}}
{{Note| You can only add a new project if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.}}
#[[Data Sharing Manager/Projects#view|View Projects]].
#[[Data Sharing Manager/Projects#view project|View Projects]].
#Click <i class="fas fa-plus"></i>.
#Click <i class="fas fa-plus"></i>.
#:The '''Project details''' dialog box is displayed.
#:The '''Project details''' dialog box is displayed.
#In '''Project name''', type the name of the new project.
#In '''Project name''', type the name of the new project.
#add point 3 from above section.  
#If required, edit one or more of the following:
#add in information on each tab
#:*Business case
#:*Summary
#:*Objectives
#:*Project lead
#:*Project technical lead
#:*Storage protocol
#:*Patient consent model
#:*De-identification level
#:*Project type (extract, query, API, distribution)
#:*Status
#:*Start date
#:*End date
#:*Application policy
#:*Config name (only displayed if the project type is distribution)
#:*Authorised check box
#Click '''Save project'''.
{{Note| A project must belong to a data sharing agreement and having publishing organisations in order for data to be shared with a subscriber.}}
 
==== Assign a sharing agreement ====
 
# In the project details page, click '''Sharing agreements'''. 
# Click <i class="fas fa-plus"></i> to add a new item, in the '''Add dialog''' box, select one or more of the available items, and then click '''Add selected'''.
#:: {{Note| The sharing agreements available are a pre-defined list. To add a new sharing agreement, see [[Data Sharing Manager/Data sharing agreements#add|Add a new data sharing agreement]] }}.
 
==== Assign a publisher ====
 
#In the project details page, click '''Publishers'''. 
# Click  to add a new item, in the '''Add dialog''' box, select one or more of the available items, and then click '''Add selected'''.
# Note: The publishing organisations available are a pre-defined list from the assigned sharing agreement.
 
<span id="data sets"></span>
 
==Data sets==
<span id="view data set"></span>
===View Data sets===
 
#[https://wiki.discoverydataservice.org/Access_Data_Sharing_Manager Access Data Sharing Manager].
# If required, in the [https://wiki.discoverydataservice.org/Navigation_side_menu Navigation side menu], click <i class="fas fa-layer-group fa-lg"></i> '''Data sets'''.
#:{{Tip|1=Click <i class="fas fa-arrow-up"></i> next to '''Name''' to order the data sets and use the page navigations to show more rows per page or to easily access another page.}}
 
<span id="view data set details"></span>
 
===View Data set details===
#[[Data Sharing Manager/Projects#view data set|View Data sets]].
#If required, click the tab links to display details for one or more of the following:
#:*Processing agreements
#:*Sharing agreements
#:*Projects
#:*Regions
#:{{Tip|1=The number of items is displayed next to each tab link.}}
#If required, click the link of the required item to view further details.
 
<span id="edit data set"></span>
 
===Edit a data set===
{{Note| You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.}}
#[[Data Sharing Manager/Projects#view data set details|View data set details]].
#Click <i class="fas fa-pencil"></i> to edit the selected data set.  The '''Data set details''' dialog box is displayed.
#If required, edit one or more of the following:
#:*Data set name
#:*Description
#:*Technical definition
#Click '''Save data set'''.
#If required, in one or more of the item tabs, do one of the following:
#*Click <i class="fas fa-plus"></i>  to add a new item, then, in the '''Add''' dialog box, select one or more of the available items, and then click '''Add selected'''.
#*Select one or more of the existing items, click <i class="fas fa-trash"; style="color:orange"></i>, and then, in the '''Remove''' dialog box, click '''Remove'''.
#*:{{Tip| Use the parent checkbox to select or deselect all items.}}
<span id="add data set"></span>
 
===Add a new data set===
{{Note| You can only add a new data set if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.}}
#[[Data Sharing Manager/Projects#view data set|View Data sets]].
#Click <i class="fas fa-plus"></i>.
#:The '''Data set details''' dialog box is displayed.
#In '''Data set name''', type the name of the new data set.
#If required, add details for one or more of the following:
#*Description
#*Technical description
#Click '''Save data set'''.
#If required, in one or more of the following, click <i class="fas fa-plus"></i>:
#*Processing agreements
#*Sharing agreements
#*Projects
#*Regions
#*:The relevant '''Add''' dialog box is displayed.
#Select one or more of the available items, and then click '''Add'''.
<span id="cohorts"></span>
 
==Cohorts==
<span id="view cohort"></span>
===View Cohorts===
 
#[https://wiki.discoverydataservice.org/Access_Data_Sharing_Manager Access Data Sharing Manager].
# If required, in the [https://wiki.discoverydataservice.org/Navigation_side_menu Navigation side menu], click <i class="fas fa-people-group fa-lg"></i> '''Cohorts'''.
#:{{Tip|1=Click <i class="fas fa-arrow-up"></i> next to '''Name''' to order the cohorts and use the page navigations to show more rows per page or to easily access another page.}}


== Assign or remove a sharing agreement ==
<span id="view cohort details"></span>


== Assign or remove a publisher ==
===View cohort details===
This is a pre-defined list from the organisations available in the sharing agreement
#[[Data Sharing Manager/Projects#view cohort|View Cohorts]].
#Click the link of the required cohort.
#If required, click the tab links to display details for one or more of the following:
#:*Processing agreements
#:*Sharing agreements
#:*Projects
#:*Regions
#:{{Tip|1=The number of items is displayed next to each tab link.}}
#If required, click the link of the required item to view further details.
 
<span id="edit cohort"></span>
 
===Edit a cohort===
{{Note| You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.}}
#[[Data Sharing Manager/Projects#view cohort details|View cohort details]].
#Click <i class="fas fa-pencil"></i> to edit the selected cohort.  The '''Cohort details''' dialog box is displayed.
#If required, edit one or more of the following:
#:*Cohort name
#:*Description
#:*Technical definition
#Click '''Save cohort'''.
#If required, in one or more of the item tabs, do one of the following:
#*Click <i class="fas fa-plus"></i>  to add a new item, then, in the '''Add''' dialog box, select one or more of the available items, and then click '''Add selected'''.
#*Select one or more of the existing items, click <i class="fas fa-trash"></i>, and then, in the '''Remove''' dialog box, click '''Remove'''.
#*:{{Tip| Use the parent checkbox to select or deselect all items.}}
 
<span id="add cohort"></span>
 
===Add a cohort===
{{Note| You can only add a new cohort if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.}}
#[[Data Sharing Manager/Projects#view cohort|View Cohorts]].
#Click <i class="fas fa-plus"></i>.
#:The '''Cohort details''' dialog box is displayed.
#In '''Cohort name''', type the name of the new data set.
#If required, add details for one or more of the following:
#*Description
#*Technical description
#Click '''Save cohort'''.
#If required, in one or more of the following, click <i class="fas fa-plus"></i>:
#*Processing agreements
#*Sharing agreements
#*Projects
#*Regions
#*:The relevant '''Add''' dialog box is displayed.
#Select one or more of the available items, and then click '''Add'''.


'''See also:'''
'''See also:'''
Line 89: Line 248:
*[[Data Sharing Manager/Regions|Regions]]
*[[Data Sharing Manager/Regions|Regions]]
*[[Data Sharing Manager/Organisations|Organisations]]
*[[Data Sharing Manager/Organisations|Organisations]]
*[[Data Sharing Manager/Services|Services]]
*[[Data Sharing Manager/Data processing agreements|Data processing agreements]]
*[[Data Sharing Manager/Data processing agreements|Data processing agreements]]
*[[Data Sharing Manager/Data sharing agreements|Data sharing agreements]]
*[[Data Sharing Manager/Data sharing agreements|Data sharing agreements]]
*[[Data Sharing Manager/Data sets|Data sets]]
*[[Data Sharing Manager/Cohorts|Cohorts]]
*[[Data Sharing Manager/Reporting|Reporting]]
*[[Data Sharing Manager/Reporting|Reporting]]
*[[Data Sharing Manager/Subscriber dashboard|Subscriber dashboard]]
*[[Data Sharing Manager/Subscriber dashboard|Subscriber dashboard]]
*[[Data Sharing Manager/Audit|Audit]]

Latest revision as of 12:52, 28 March 2023

Projects are defined in Data Sharing Manager as the detailed configuration of a specific data sharing agreement use case. Use Data Sharing Manager to view, manage, or add projects.
Data sets define what data is used in a project in Data Sharing Manager. Use Data Sharing Manager to view, manage, or add data sets.
Cohorts define the criteria that is used to select the patients for projects in Data Sharing Manager. Use Data Sharing Manager to view, manage, or add cohorts.

Publisher’s data will not be shared with a subscriber unless there is an active data sharing agreement and an active project in Data Sharing Manager.

Use this section to help you to:

Projects

Data sets

Cohorts

You must make sure that any required changes to a project, such as removing a publisher or subscriber organisation, or if the project is no longer active, is reflected in Data Sharing Manager. Any changes made in Data Sharing Manager will affect the live service.

Projects

View Projects

  1. Access Data Sharing Manager.
  2. If required, in the Navigation side menu, click Projects.
    Click next to Name to order the projects and use the page navigations to show more rows per page or to easily access another page.

View project details

  1. View Projects.
  2. Click the link of the required project.
  3. If required, click the tab links to display details for one or more of the following:
    • Sharing agreements
    • Publishers
    • Subscribers
    • Documents
    • Cohorts
    • Data sets
    • Authority to share
    The number of items is displayed next to each tab link.
  4. If required, click the link of the required item to view further details.

Edit a project

You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.
Any changes to the project status, project dates, or the publisher and subscriber organisations, directly affect the live project. If you want to remove a publisher from the project, please remove them from the project publisher organisations and contact us at support@voror.co.uk so that we can revoke the subscriber’s access to the data.
  1. View project details.
  2. Click to edit the selected project. The Project details dialog box is displayed.
  3. If required, edit one or more of the following:
    • Project name
    • Business case
    • Summary
    • Objectives
    • Project lead
    • Project technical lead
    • Storage protocol
    • Patient consent model
    • De-identification level
    • Project type (extract, query, API, distribution)
    • Status
    • Start date
    • End date
    • Application policy
    • Config name (only displayed if the project type is distribution)
    • Authorised checkbox
  4. Click Save project.
  5. If required, in one or more of the following:
    • Sharing agreements
    • Publishers - this is a pre-defined list from the organisations available in the sharing agreement
    • Subscribers - this is a pre-defined list from the organisations available in the sharing agreement
    • Documents
    • Cohort - this is a pre-defined list of existing cohorts. To create a new cohort see Cohorts.
    • Data sets - this is a pre-defined list of existing data sets. To create a new data set see Data sets.
  6. Click to add a new item, in the Add dialog box, select one or more of the available items, and then click Add selected.
  7. Select one or more of the existing items, click , and then, in the Remove dialog box, click Remove.
    Use the parent checkbox to select or deselect all items.

Add a project

You can only add a new project if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.
  1. View Projects.
  2. Click .
    The Project details dialog box is displayed.
  3. In Project name, type the name of the new project.
  4. If required, edit one or more of the following:
    • Business case
    • Summary
    • Objectives
    • Project lead
    • Project technical lead
    • Storage protocol
    • Patient consent model
    • De-identification level
    • Project type (extract, query, API, distribution)
    • Status
    • Start date
    • End date
    • Application policy
    • Config name (only displayed if the project type is distribution)
    • Authorised check box
  5. Click Save project.
A project must belong to a data sharing agreement and having publishing organisations in order for data to be shared with a subscriber.

Assign a sharing agreement

  1. In the project details page, click Sharing agreements.
  2. Click to add a new item, in the Add dialog box, select one or more of the available items, and then click Add selected.
    The sharing agreements available are a pre-defined list. To add a new sharing agreement, see Add a new data sharing agreement
    .

Assign a publisher

  1. In the project details page, click Publishers.
  2. Click to add a new item, in the Add dialog box, select one or more of the available items, and then click Add selected.
  3. Note: The publishing organisations available are a pre-defined list from the assigned sharing agreement.

Data sets

View Data sets

  1. Access Data Sharing Manager.
  2. If required, in the Navigation side menu, click Data sets.
    Click next to Name to order the data sets and use the page navigations to show more rows per page or to easily access another page.

View Data set details

  1. View Data sets.
  2. If required, click the tab links to display details for one or more of the following:
    • Processing agreements
    • Sharing agreements
    • Projects
    • Regions
    The number of items is displayed next to each tab link.
  3. If required, click the link of the required item to view further details.

Edit a data set

You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.
  1. View data set details.
  2. Click to edit the selected data set. The Data set details dialog box is displayed.
  3. If required, edit one or more of the following:
    • Data set name
    • Description
    • Technical definition
  4. Click Save data set.
  5. If required, in one or more of the item tabs, do one of the following:
    • Click to add a new item, then, in the Add dialog box, select one or more of the available items, and then click Add selected.
    • Select one or more of the existing items, click , and then, in the Remove dialog box, click Remove.
      Use the parent checkbox to select or deselect all items.

Add a new data set

You can only add a new data set if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.
  1. View Data sets.
  2. Click .
    The Data set details dialog box is displayed.
  3. In Data set name, type the name of the new data set.
  4. If required, add details for one or more of the following:
    • Description
    • Technical description
  5. Click Save data set.
  6. If required, in one or more of the following, click :
    • Processing agreements
    • Sharing agreements
    • Projects
    • Regions
      The relevant Add dialog box is displayed.
  7. Select one or more of the available items, and then click Add.

Cohorts

View Cohorts

  1. Access Data Sharing Manager.
  2. If required, in the Navigation side menu, click Cohorts.
    Click next to Name to order the cohorts and use the page navigations to show more rows per page or to easily access another page.

View cohort details

  1. View Cohorts.
  2. Click the link of the required cohort.
  3. If required, click the tab links to display details for one or more of the following:
    • Processing agreements
    • Sharing agreements
    • Projects
    • Regions
    The number of items is displayed next to each tab link.
  4. If required, click the link of the required item to view further details.

Edit a cohort

You can only edit existing details if you have the correct user and project permissions. If you do not have the correct permissions, the edit functionality is not available to your user.
  1. View cohort details.
  2. Click to edit the selected cohort. The Cohort details dialog box is displayed.
  3. If required, edit one or more of the following:
    • Cohort name
    • Description
    • Technical definition
  4. Click Save cohort.
  5. If required, in one or more of the item tabs, do one of the following:
    • Click to add a new item, then, in the Add dialog box, select one or more of the available items, and then click Add selected.
    • Select one or more of the existing items, click , and then, in the Remove dialog box, click Remove.
      Use the parent checkbox to select or deselect all items.

Add a cohort

You can only add a new cohort if you have the correct user and project permissions. If you do not have the correct permissions, the add functionality is not available to your user.
  1. View Cohorts.
  2. Click .
    The Cohort details dialog box is displayed.
  3. In Cohort name, type the name of the new data set.
  4. If required, add details for one or more of the following:
    • Description
    • Technical description
  5. Click Save cohort.
  6. If required, in one or more of the following, click :
    • Processing agreements
    • Sharing agreements
    • Projects
    • Regions
      The relevant Add dialog box is displayed.
  7. Select one or more of the available items, and then click Add.

See also: