Data Sharing Manager/API calls through DSM - Revision history

AdminJo at 11:29, 30 April 2025

2025-04-30T11:29:55Z

← Older revision		Revision as of 11:29, 30 April 2025
Line 3:		Line 3:
	This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details:		This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details:
	# When an API call is made, Keycloak checks the user ID.		# When an API call is made, Keycloak checks the user ID.
	#~~DSM~~ then uses the user ID to determine which project that user ID has access to.		#Data Sharing Manager then uses the user ID to determine which project that user ID has access to.
	# The project information in ~~DSM~~ determines which organisation’s (publishers) data is made available, and the associated config entry.		# The project information in Data Sharing Manager determines which organisation’s (publishers) data is made available, and the associated config entry.
	# The ~~DDS UI~~ config entry is used to access the configuration information in the config database; this determines which internal Compass database can be accessed.		# The Data Service Manager config entry is used to access the configuration information in the config database; this determines which internal Compass database can be accessed.
	The following examples show how access differs depending on the project information and publisher lists. We will assume that the Internal Compass Database holds data for 100 organisations.		The following examples show how access differs depending on the project information and publisher lists. We will assume that the Internal Compass Database holds data for 100 organisations.

	{{Note\|These examples use the same config entry and the same Internal Compass Database, however the project information in the ~~DSM~~ is unique to each project.}}		{{Note\|These examples use the same config entry and the same Internal Compass Database, however the project information in the Data Sharing Manager is unique to each project.}}

	===Example 1: The project only has access to 10 of the 100 organisations===		===Example 1: The project only has access to 10 of the 100 organisations===

ErgoSoftUK at 14:22, 28 March 2023

2023-03-28T14:22:35Z

← Older revision		Revision as of 14:22, 28 March 2023
Line 1:		Line 1:
			[[File:API call overview.png\|API call overview]]

	This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details:		This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details:
	# When an API call is made, Keycloak checks the user ID.		# When an API call is made, Keycloak checks the user ID.

JoC: Created page with "This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details: # When an API call is made, Keycloak checks the user ID. #DSM then uses the user ID to determine which project that user ID has access to. # The project information in DSM determines which organisation’s (publishers) data is made available, and the associated config entry. # The DDS UI config entry is used to access the configuration..."

2023-03-28T12:40:50Z

Created page with "This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details: # When an API call is made, Keycloak checks the user ID. #DSM then uses the user ID to determine which project that user ID has access to. # The project information in DSM determines which organisation’s (publishers) data is made available, and the associated config entry. # The DDS UI config entry is used to access the configuration..."

New page

This diagram shows, at a high level, the way the API calls, and the associated projects, are given access to the correct patient details:
# When an API call is made, Keycloak checks the user ID.
#DSM then uses the user ID to determine which project that user ID has access to.
# The project information in DSM determines which organisation’s (publishers) data is made available, and the associated config entry.
# The DDS UI config entry is used to access the configuration information in the config database; this determines which internal Compass database can be accessed.
The following examples show how access differs depending on the project information and publisher lists. We will assume that the Internal Compass Database holds data for 100 organisations.

{{Note|These examples use the same config entry and the same Internal Compass Database, however the project information in the DSM is unique to each project.}}

===Example 1: The project only has access to 10 of the 100 organisations===
[[File:API call project 1.png|Project 1]]

===Example 2: The project only has access to 50 of the 100 organisations===
[[File:API call project 2.png|Project 2]]

===Example 3: The project has access to all 100 organisations===
[[File:API call project 3.png|Project 3]]